{"items":[{"type":"link","label":"Peach Finance API","link":"/api-docs/api-public","routeSlug":"/api-docs/api-public","content":{"contentType":"overview","meta":{"name":"Peach Finance API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-public.json","url":"/_bundle/API Docs/@2025-03-26/api-public.json?download"},{"kind":"download","label":"api-public.yaml","url":"/_bundle/API Docs/@2025-03-26/api-public.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"apiteam@peachfinance.com","label":"apiteam@peachfinance.com","withCopyButton":true,"copyContent":"apiteam@peachfinance.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://www.peachfinance.com/terms-of-use"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.peachfinance.com/terms-of-use"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"java","title":"Java","lang":"Java"},{"key":"go","title":"Go","lang":"Go"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Peach Finance API (2025-03-26)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api-docs/api-public"}],"sectionId":"/api-docs/api-public"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is organized around "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Representational_state_transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and uses standard HTTP response codes, authentication, and verbs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the API in test mode, which does not affect your live data. The API key you use to authenticate the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request determines whether the request is in live mode or test mode."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is versioned. For more information see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.peachfinance.com/api-versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Versioning Docs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available versions—and the breaking changes associated with them—see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.peachfinance.com/api-docs/breaking-changes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breaking Changes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". (Requires Docs Hub login.)"},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/versioning"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach Finance API utilizes cursor-based pagination via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingAfter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. Both parameters take an existing Object ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value and return objects in reverse chronological order. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingBefore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter returns objects listed before the named object. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingAfter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter returns objects listed after the named object. If both parameters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are provided, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The size of the page can be limited using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional; the default is 25 and can be between 1 and 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not currently supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some endpoints will allow sending a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, enumerating the fields that can be used to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sort the results returned by that particular endpoint. For example, if the results can be sorted by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy=[updatedAt, -createdAt]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return the results sorted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in ascending order and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in descending order lexicographically."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some Peach objects have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. You can use this attribute to pass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key-value data as part of an object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata can be used when you need to store additional information on an object. Metadata"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not used by Peach. It is stored as part of an object and returned to you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not store any personal identifiable information (such as SSN) as metadata. Use dedicated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes for PII as these attributes are encrypted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Metadata attribute can hold up to 50 keys, with key names up to 100 characters long and values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"up to 500 characters long."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/metadata"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/attributes-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some Peach attributes use common formats."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rate, promo rate and APR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rates are annual. Format is decimal. For example, 0.005 is 0.5% annual rate, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Dates are in format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Dates are computed relative to either"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the company timezone, which is configured on the company config, or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the product timezone, which is configured on the Loan Type.  Note: it is possible for a company to have multiple products with different timezones."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date-times"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Timestamps are in ISO-8601 format expressed either in UTC like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2001-01-01T12:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or with UTC offset like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2001-01-01T12:00:00-07:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Some date-times will include subsecond precision to an arbitrary number of digits like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2001-01-01T12:00:00.123Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Amounts are in decimal format with 2 places after the decimal point. For example, 32.45 is thirty-two dollars and forty-five cents."},"children":[]}]}]}]}]}],"sectionId":"/api-docs/api-public/section/attributes-formats"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/identifiers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach objects always have unique identifiers created by Peach. Some objects support external IDs. If external ID is supported, the object will have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. You can fetch objects using external ID (only objects that support external IDs)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach IDs have the same format XX-YYYY-YYYY."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XX - is a prefix from the list below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YYYY-YYYY - is a random set of numbers and letters (capital characters A-Z and digits 1-9). The digit zero is not used to avoid confusion with capital letter O."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/identifiers"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/identifiers/external-ids"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External IDs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External IDs allows avoiding the need to map IDs between your system and Peach. You can pass your IDs when creating various objects at Peach and then use the same IDs to fetch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the information back."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When fetching data with external IDs or when sending a request that requires a reference to an object using its external ID (for example, inside a body of a POST request), there is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a need to add a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in front of the ID. This will make sure Peach knows these are external IDs being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, fetching a borrower using the external ID would look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/people/ext-MY_EXTERNAL_BORROWER_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating objects with external IDs, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix is not needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, when creating a new borrower the body would look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /api/people\n{\n  \"externalId\" : \"MY_EXTERNAL_BORROWER_ID\"\n  ...\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /api/people\n{\n  \"externalId\" : \"MY_EXTERNAL_BORROWER_ID\"\n  ...\n}\n"},"children":[]}]}]}],"sectionId":"/api-docs/api-public/section/identifiers/external-ids"}],"sectionId":"/api-docs/api-public/section/identifiers/external-ids"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/identifiers/list-of-prefixes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of Prefixes"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BO"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person Name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person Identity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Investor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Draw"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment Advances"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TX"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EV"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EM"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Descriptor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person Monitoring Status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do Not Interact Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do Not Interact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template Descriptor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TV"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template Version"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CO"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Rule"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMA Disaster Details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consent"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal Representative"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PM"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Step Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Item Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Step"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Workitem"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification Attempt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obligation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repayment Notification Descriptor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan People"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InterestRate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period (loan)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Investor Association"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SM"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement Activity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement Draw Info"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay Expected Payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEMA Disaster"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Tape Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Tape"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Reporting Status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Agency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection Agency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Issuer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACHFile Upload Monitoring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding Account Balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower Campaign"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Run"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CX"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact  Exporter"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Chargeback"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Period"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Label"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Call Transcription Result"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SU"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Call Summary Result"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Cap"},"children":[]}]}]}]}]}]}]}],"sectionId":"/api-docs/api-public/section/identifiers/list-of-prefixes"}],"sectionId":"/api-docs/api-public/section/identifiers/list-of-prefixes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system supports pull events via our REST API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can see more information "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/events"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/events"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/compliance-guard"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Guard"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Guard covers core regulatory obligations related to servicing and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collections. It does not cover rules required for debt collection agencies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(though some of them are applicable to creditors and servicers as a best"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"practice.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Guard allows you to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run real-time regulatory checks before initiating an outbound communication"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a borrower. Rules cover laws on the federal level and 50 states + DC. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system runs appropriate rules based on loan type, loan status, location of a borrower,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower status, and past communications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor for bankruptcy, deceased, active military, and FEMA (disasters). You can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monitor for all four or any combination of the four. On hits, we automatically create \"cases\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with all details, block future outbound communications (if needed), and notify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you about the cases."},"children":[]}]}]}]}]}],"sectionId":"/api-docs/api-public/section/compliance-guard"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/compliance-guard/configuring-compliance-guard"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuring Compliance Guard"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will configure an appropriate loan type for you. It allows us to select a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined set of regulatory rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will work with you to override regulatory rules based on your risk appetite. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can \"mute\" rules. You can add rules. This is typically done with your legal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and compliance teams."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will work with you to add business rules based on your needs. For example, don't"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allow outbound debt collection calls on Sundays. This is typically done with your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operations and product teams."},"children":[]}]}]}]}]}],"sectionId":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard"}],"sectionId":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/compliance-guard/implementing-compliance-guard-in-your-system"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implementing Compliance Guard in your system"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to create borrower and loan objects in the Peach system. For more details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/borrowers"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/loans"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to report all communications with a borrower. Not required for monitoring."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This way Peach can track all interactions with the borrower. For more details see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/communicator"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Communicator & Interactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending a communication through Peach it will automatically check Compliance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guard rules to determiend if the communication is compliant. If it is not compliant,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the communication will not be rejected. (Some send endpoints do not perform"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Guard checks, but they should be clearly marked.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also manually check if a communication is compliant by using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can interact"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}],"sectionId":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system"}],"sectionId":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/locks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach ensures consistency of the loan's ledger and balances. In order to make sure that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple operations are not writing to the ledger at the same time, Peach uses locks to protect"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the consistency of the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In situations where an API call affects a loan's ledger, the system will lock the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan to protect its consistency. Subsequent calls that affect that loan's ledger might"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if the loan is still locked. In these cases, you can make"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a call to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock Status"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to check if the loan is still locked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are trying to make a call and get "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", consider polling on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock Status"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to check when the lock is released. Most locks are short."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some API calls (e.g. retroactive interest adjustment or payment backdate)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can trigger a loan replay. Loan replays can last several minutes, during which the loan will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be locked."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/locks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/sync-calls"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of the API endpoints are asynchronous by design. There are situations in which you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"might want to wait until the API call/operation finishes. Some API endpoints have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a special query parameter called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Payment Instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Purchase"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the call will be blocked until the async operation has finished."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the operation takes too long, you will get a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408 Request Timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In that case, you need to poll on that specific operations' result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: if you make a call to add a Payment Instrument, and it times out, you can poll"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment-instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to see if the new payment instrument has been added."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/sync-calls"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BETA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Standardization of error response bodies is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach uses conventional HTTP response codes to indicate the success or failure of an API request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resulted from the provided information (e.g., a required parameter was missing), and codes in the 5xx"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range indicate an error with the Peach service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response bodies have the following JSON format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"statusCode\": 400,\n    \"message\": \"A description of the error.\",\n    \"errorType\": \"TheErrorType\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"statusCode\": 400,\n    \"message\": \"A description of the error.\",\n    \"errorType\": \"TheErrorType\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of error types, see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/errors"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"sectionId":"/api-docs/api-public/section/errors"}]}]}},{"type":"link","label":"Introduction","link":"/api-docs/api-public/section/introduction","routeSlug":"/api-docs/api-public/section/introduction","content":null},{"type":"link","label":"Versioning","link":"/api-docs/api-public/section/versioning","routeSlug":"/api-docs/api-public/section/versioning","content":null},{"type":"link","label":"Pagination","link":"/api-docs/api-public/section/pagination","routeSlug":"/api-docs/api-public/section/pagination","content":null},{"type":"link","label":"Metadata","link":"/api-docs/api-public/section/metadata","routeSlug":"/api-docs/api-public/section/metadata","content":null},{"type":"link","label":"Attributes Formats","link":"/api-docs/api-public/section/attributes-formats","routeSlug":"/api-docs/api-public/section/attributes-formats","content":null},{"type":"group","label":"Identifiers","link":"/api-docs/api-public/section/identifiers","routeSlug":"/api-docs/api-public/section/identifiers","items":[{"type":"link","label":"External IDs","link":"/api-docs/api-public/section/identifiers/external-ids","routeSlug":"/api-docs/api-public/section/identifiers/external-ids","content":null},{"type":"link","label":"List of Prefixes","link":"/api-docs/api-public/section/identifiers/list-of-prefixes","routeSlug":"/api-docs/api-public/section/identifiers/list-of-prefixes","content":null}],"content":null},{"type":"link","label":"Events","link":"/api-docs/api-public/section/events","routeSlug":"/api-docs/api-public/section/events","content":null},{"type":"group","label":"Compliance Guard","link":"/api-docs/api-public/section/compliance-guard","routeSlug":"/api-docs/api-public/section/compliance-guard","items":[{"type":"link","label":"Configuring Compliance Guard","link":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard","routeSlug":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard","content":null},{"type":"link","label":"Implementing Compliance Guard in your system","link":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system","routeSlug":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system","content":null}],"content":null},{"type":"link","label":"Locks","link":"/api-docs/api-public/section/locks","routeSlug":"/api-docs/api-public/section/locks","content":null},{"type":"link","label":"Sync calls","link":"/api-docs/api-public/section/sync-calls","routeSlug":"/api-docs/api-public/section/sync-calls","content":null},{"type":"link","label":"Errors","link":"/api-docs/api-public/section/errors","routeSlug":"/api-docs/api-public/section/errors","content":null},{"type":"separator","label":"Frontend Integration","content":null},{"type":"group","label":"Frontend","link":"/api-docs/api-public/frontend","routeSlug":"/api-docs/api-public/frontend","items":[{"label":"Get bootstrap data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/frontend/peach.security.handlers.bootstrap","routeSlug":"/api-docs/api-public/frontend/peach.security.handlers.bootstrap","metadata":{"seo":{"title":"Get bootstrap data","description":"Get pre-auth app metadata and settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.bootstrap","name":"Get bootstrap data","isWebhook":false,"pointer":"/paths/~1bootstrap/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bootstrap data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get pre-auth app metadata and settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch metadata and settings for a Peach application. This endpoint is public readable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"because this information is necessary to properly render the frontend even for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"users who are not yet logged-in — i.e., the login page needs to have the right"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name and color scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since multiple frontend application are supported by the backend you must specify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frontend application this bootstrap request is intended. The best way"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to do this is by specifying domain. e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain=myappdomain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". (Please note"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that a \"Company App Domain\" must already be configured for your environment for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this to work. There is no public API for this yet, so contact support.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may also specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appDomainType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but this is discouraged and mostly intended for development / debugging."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"schema_5612","description":"The unique company identifier."},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus","description":"A valid domain associated with a company"},{"name":"appDomainType","in":"query","schemaId":"schema_5613","description":"App Domain Type."}],"pointer":"/paths/~1bootstrap/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bootstrap","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","schemaId":"schema_5612"},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus"},{"name":"appDomainType","in":"query","schemaId":"components/schemas/AppDomainType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/bootstrap","href":"frontend/peach.security.handlers.bootstrap","openApiOperationId":"peach.security.handlers.bootstrap","summary":"Get bootstrap data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FrontendPreauthBootstrap"}},"schemaId":"components/schemas/FrontendPreauthBootstrap"}],"pointer":"/paths/~1bootstrap/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FrontendPreauthBootstrap","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FrontendPreauthBootstrap"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/frontend/peach.security.handlers.bootstrap"}],"panels":[]}]},"httpPath":"/bootstrap"}],"content":{"contentType":"group","meta":{"name":"Frontend"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Frontend","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for use in configuring the frontend before and after authentication."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bootstrap","summary":"Get bootstrap data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/frontend/peach.security.handlers.bootstrap","deprecated":false}]}]}]}]}},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Auth","link":"/api-docs/api-public/auth","routeSlug":"/api-docs/api-public/auth","items":[{"label":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.exchange_token_create","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.exchange_token_create","metadata":{"seo":{"title":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","description":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.exchange_token_create","name":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","isWebhook":false,"pointer":"/paths/~1auth~1exchange-token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["auth:exchange-token"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5614"}},"schemaId":"schema_5614","pointer":"/paths/~1auth~1exchange-token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/exchange-token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["auth:exchange-token"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5614"}},"responseCodes":["200"],"pointer":"/auth/exchange-token","href":"auth/peach.security.handlers.exchange_token_create","openApiOperationId":"peach.security.handlers.exchange_token_create","summary":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","securityGroups":[{"oauth2":["auth:exchange-token"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5614","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5614"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5615"}},"schemaId":"schema_5615"}],"pointer":"/paths/~1auth~1exchange-token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.exchange_token_create"}],"panels":[]}]},"httpPath":"/auth/exchange-token"},{"label":"Change password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.password_post","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.password_post","metadata":{"seo":{"title":"Change password","description":"Change password"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.password_post","name":"Change password","isWebhook":false,"pointer":"/paths/~1auth~1password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"schemaId":"schema_5616","pointer":"/paths/~1auth~1password/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/password","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5616"}},"responseCodes":["200"],"pointer":"/auth/password","href":"auth/peach.security.handlers.password_post","openApiOperationId":"peach.security.handlers.password_post","summary":"Change password","securityGroups":[{"oauth2":[]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5616","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1auth~1password/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.password_post"}],"panels":[]}]},"httpPath":"/auth/password"},{"label":"Get all permissions for the requesting user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.permissions_get","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.permissions_get","metadata":{"seo":{"title":"Get all permissions for the requesting user","description":"Get all permissions for the requesting user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.permissions_get","name":"Get all permissions for the requesting user","isWebhook":false,"pointer":"/paths/~1auth~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all permissions for the requesting user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/permissions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/auth/permissions","href":"auth/peach.security.handlers.permissions_get","openApiOperationId":"peach.security.handlers.permissions_get","summary":"Get all permissions for the requesting user","securityGroups":[{"oauth2":[]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5617"}},"schemaId":"schema_5617"}],"pointer":"/paths/~1auth~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5617","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5617"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.permissions_get"}],"panels":[]}]},"httpPath":"/auth/permissions"},{"label":"End login session, invalidating current login token.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.logout","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.logout","metadata":{"seo":{"title":"End login session, invalidating current login token.","description":"End login session, invalidating current login token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.logout","name":"End login session, invalidating current login token.","isWebhook":false,"pointer":"/paths/~1auth~1token/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"End login session, invalidating current login token.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/auth/token","href":"auth/peach.security.handlers.logout","openApiOperationId":"peach.security.handlers.logout","summary":"End login session, invalidating current login token.","securityGroups":[{"oauth2":[]},{"bearerAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1auth~1token/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.logout"}],"panels":[]}]},"httpPath":"/auth/token"},{"label":"Exchange username and password for JWT token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.validate_and_send_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.validate_and_send_token","metadata":{"seo":{"title":"Exchange username and password for JWT token","description":"Exchange username and password for JWT token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.validate_and_send_token","name":"Exchange username and password for JWT token","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange username and password for JWT token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"schema_5612","description":"The unique company identifier."},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus","description":"A valid domain associated with a company"},{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"authType","in":"query","schemaId":"schema_5619","description":"The authentication type to explicitly use\n"},{"name":"authValueType","in":"query","schemaId":"schema_5620","description":"The authentication value type to explicitly use\n"}],"pointer":"/paths/~1auth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"schemaId":"schema_5616","pointer":"/paths/~1auth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","schemaId":"schema_5612"},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus"},{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"authType","in":"query","schemaId":"components/schemas/AuthType"},{"name":"authValueType","in":"query","schemaId":"components/schemas/AuthValueType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_5616"}},"responseCodes":["200"],"pointer":"/auth/token","href":"auth/peach.security.handlers.validate_and_send_token","openApiOperationId":"peach.security.handlers.validate_and_send_token","summary":"Exchange username and password for JWT token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5616","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWT token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}},"schemaId":"components/schemas/AuthSuccess"}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.validate_and_send_token"}],"panels":[]}]},"httpPath":"/auth/token"},{"label":"Exchange current token for a new one","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.renew_jwt_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.renew_jwt_token","metadata":{"seo":{"title":"Exchange current token for a new one","description":"Exchange current token for a new one"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.renew_jwt_token","name":"Exchange current token for a new one","isWebhook":false,"pointer":"/paths/~1auth~1token/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange current token for a new one","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/auth/token","href":"auth/peach.security.handlers.renew_jwt_token","openApiOperationId":"peach.security.handlers.renew_jwt_token","summary":"Exchange current token for a new one","securityGroups":[{"oauth2":[]},{"bearerAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWT token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}},"schemaId":"components/schemas/AuthSuccess"}],"pointer":"/paths/~1auth~1token/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.renew_jwt_token"}],"panels":[]}]},"httpPath":"/auth/token"},{"label":"Create a short-lived token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.short_lived_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.short_lived_token","metadata":{"seo":{"title":"Create a short-lived token","description":"Create a short-lived token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.short_lived_token","name":"Create a short-lived token","isWebhook":false,"pointer":"/paths/~1auth~1token~1short-lived/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a short-lived token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["auth.short-lived-token:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5621"}},"schemaId":"schema_5621","pointer":"/paths/~1auth~1token~1short-lived/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token/short-lived","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["auth.short-lived-token:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5621"}},"responseCodes":["200"],"pointer":"/auth/token/short-lived","href":"auth/peach.security.handlers.short_lived_token","openApiOperationId":"peach.security.handlers.short_lived_token","summary":"Create a short-lived token","securityGroups":[{"oauth2":["auth.short-lived-token:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5621","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5621"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWT token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}},"schemaId":"components/schemas/AuthSuccess"}],"pointer":"/paths/~1auth~1token~1short-lived/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.short_lived_token"}],"panels":[]}]},"httpPath":"/auth/token/short-lived"},{"label":"Get logged-in user's info.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.user_info_get","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.user_info_get","metadata":{"seo":{"title":"Get logged-in user's info.\n","description":"Get logged-in user's info.\n"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.user_info_get","name":"Get logged-in user's info.\n","isWebhook":false,"pointer":"/paths/~1auth~1user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get logged-in user's info.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/user","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/auth/user","href":"auth/peach.security.handlers.user_info_get","openApiOperationId":"peach.security.handlers.user_info_get","summary":"Get logged-in user's info.\n","securityGroups":[{"oauth2":[]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserInfo"}},"schemaId":"components/schemas/UserInfo"}],"pointer":"/paths/~1auth~1user/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserInfo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.user_info_get"}],"panels":[]}]},"httpPath":"/auth/user"},{"label":"SAML callback endpoint\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_initiated","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_initiated","metadata":{"seo":{"title":"SAML callback endpoint\n","description":"SAML callback endpoint\n"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.saml_sp_auth.idp_initiated","name":"SAML callback endpoint\n","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1callback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SAML callback endpoint\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1callback/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"appDomainType","in":"query","schemaId":"schema_5613","description":"App Domain Type."}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1callback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_5622"}},"schemaId":"schema_5622","pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1callback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/auth/saml/callback","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"appDomainType","in":"query","schemaId":"components/schemas/AppDomainType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_5622"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/auth/saml/callback","href":"auth/peach.security.handlers.saml_sp_auth.idp_initiated","openApiOperationId":"peach.security.handlers.saml_sp_auth.idp_initiated","summary":"SAML callback endpoint\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5622","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_5622"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1callback/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.saml_sp_auth.idp_initiated"}],"panels":[]}]},"httpPath":"/companies/{companyId}/auth/saml/callback"},{"label":"Display IdP setup help\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_setup_help","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_setup_help","metadata":{"seo":{"title":"Display IdP setup help\n","description":"Display IdP setup help\n"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.saml_sp_auth.idp_setup_help","name":"Display IdP setup help\n","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1help/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Display IdP setup help\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1help/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"appDomainType","in":"query","schemaId":"schema_5613","description":"App Domain Type."}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1help/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/auth/saml/help","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"appDomainType","in":"query","schemaId":"components/schemas/AppDomainType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/companies/{companyId}/auth/saml/help","href":"auth/peach.security.handlers.saml_sp_auth.idp_setup_help","openApiOperationId":"peach.security.handlers.saml_sp_auth.idp_setup_help","summary":"Display IdP setup help\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1help/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/newStatus","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.saml_sp_auth.idp_setup_help"}],"panels":[]}]},"httpPath":"/companies/{companyId}/auth/saml/help"},{"label":"Redirect to the SAML login endpoint\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_initiated","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_initiated","metadata":{"seo":{"title":"Redirect to the SAML login endpoint\n","description":"Redirect to the SAML login endpoint\n"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.saml_sp_auth.sp_initiated","name":"Redirect to the SAML login endpoint\n","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1login/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redirect to the SAML login endpoint\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1login/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"appDomainType","in":"query","schemaId":"schema_5613","description":"App Domain Type."},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the login instead of redirecting to the login"},"children":[]}]}]}]}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1login/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/auth/saml/login","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"appDomainType","in":"query","schemaId":"components/schemas/AppDomainType"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/companies/{companyId}/auth/saml/login","href":"auth/peach.security.handlers.saml_sp_auth.sp_initiated","openApiOperationId":"peach.security.handlers.saml_sp_auth.sp_initiated","summary":"Redirect to the SAML login endpoint\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1login/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.saml_sp_auth.sp_initiated"}],"panels":[]}]},"httpPath":"/companies/{companyId}/auth/saml/login"},{"label":"Display Peach SP Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","metadata":{"seo":{"title":"Display Peach SP Metadata","description":"Peach acts as the service provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.saml_sp_auth.sp_metadata_xml","name":"Display Peach SP Metadata","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1metadata.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Display Peach SP Metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Peach acts as the service provider\n"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1metadata.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"appDomainType","in":"query","schemaId":"schema_5613","description":"App Domain Type."}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1metadata.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/auth/saml/metadata.xml","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"appDomainType","in":"query","schemaId":"components/schemas/AppDomainType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/companies/{companyId}/auth/saml/metadata.xml","href":"auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","openApiOperationId":"peach.security.handlers.saml_sp_auth.sp_metadata_xml","summary":"Display Peach SP Metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"text/xml","mediaTypes":["text/xml"],"mediaTypeContent":{"text/xml":{"schemaId":"components/schemas/VirtualCardIssuerPut"}},"schemaId":"components/schemas/VirtualCardIssuerPut"}],"pointer":"/paths/~1companies~1{companyId}~1auth~1saml~1metadata.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualCardIssuerPut","mediaTypes":["text/xml"],"mediaTypeContent":{"text/xml":{"schemaId":"components/schemas/VirtualCardIssuerPut"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml"}],"panels":[]}]},"httpPath":"/companies/{companyId}/auth/saml/metadata.xml"},{"label":"Send one time code.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.send_one_time_code","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.send_one_time_code","metadata":{"seo":{"title":"Send one time code.\n","description":"Send a one time code to a phone number or email address. For phone numbers, the code can be sent via text or voice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.send_one_time_code","name":"Send one time code.\n","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1auth~1send-one-time-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send one time code.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a one time code to a phone number or email address. For phone numbers, the code\ncan be sent via text or voice.\n"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1auth~1send-one-time-code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5624"}},"schemaId":"schema_5624","pointer":"/paths/~1companies~1{companyId}~1auth~1send-one-time-code/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/auth/send-one-time-code","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_5624"}},"responseCodes":["202","429"],"pointer":"/companies/{companyId}/auth/send-one-time-code","href":"auth/peach.security.handlers.send_one_time_code","openApiOperationId":"peach.security.handlers.send_one_time_code","summary":"Send one time code.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5624","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5624"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No input errors were found. i.e., The one time code "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have been sent successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We do not reveal if a borrower is found and a message successfully sent in order to prevent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an attacker from learning if the given phone number or email addresse is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the system."},"children":[]}]}]}]},{"code":"429","description":"This request has been rate limited; please try again later.\n"}],"pointer":"/paths/~1companies~1{companyId}~1auth~1send-one-time-code/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.send_one_time_code"}],"panels":[]}]},"httpPath":"/companies/{companyId}/auth/send-one-time-code"},{"label":"End login session, invalidating current login token.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_logout","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_logout","metadata":{"seo":{"title":"End login session, invalidating current login token.","description":"End login session, invalidating current login token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.compliance_logout","name":"End login session, invalidating current login token.","isWebhook":false,"pointer":"/paths/~1compliance~1auth~1token/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"End login session, invalidating current login token.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/compliance/auth/token","href":"auth/peach.security.handlers.compliance_logout","openApiOperationId":"peach.security.handlers.compliance_logout","summary":"End login session, invalidating current login token.","securityGroups":[{"oauth2":[]},{"bearerAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1compliance~1auth~1token/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.compliance_logout"}],"panels":[]}]},"httpPath":"/compliance/auth/token"},{"label":"Exchange username and password for JWT token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_validate_and_send_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_validate_and_send_token","metadata":{"seo":{"title":"Exchange username and password for JWT token","description":"Exchange username and password for JWT token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.compliance_validate_and_send_token","name":"Exchange username and password for JWT token","isWebhook":false,"pointer":"/paths/~1compliance~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange username and password for JWT token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"schema_5612","description":"The unique company identifier."},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus","description":"A valid domain associated with a company"},{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"authType","in":"query","schemaId":"schema_5619","description":"The authentication type to explicitly use\n"},{"name":"authValueType","in":"query","schemaId":"schema_5620","description":"The authentication value type to explicitly use\n"}],"pointer":"/paths/~1compliance~1auth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"schemaId":"schema_5616","pointer":"/paths/~1compliance~1auth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","schemaId":"schema_5612"},{"name":"domain","in":"query","schemaId":"components/schemas/newStatus"},{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"authType","in":"query","schemaId":"components/schemas/AuthType"},{"name":"authValueType","in":"query","schemaId":"components/schemas/AuthValueType"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_5616"}},"responseCodes":["200"],"pointer":"/compliance/auth/token","href":"auth/peach.security.handlers.compliance_validate_and_send_token","openApiOperationId":"peach.security.handlers.compliance_validate_and_send_token","summary":"Exchange username and password for JWT token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5616","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5616"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWT token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}},"schemaId":"components/schemas/AuthSuccess"}],"pointer":"/paths/~1compliance~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.compliance_validate_and_send_token"}],"panels":[]}]},"httpPath":"/compliance/auth/token"},{"label":"Exchange current token for a new one","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_renew_jwt_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_renew_jwt_token","metadata":{"seo":{"title":"Exchange current token for a new one","description":"Exchange current token for a new one"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.compliance_renew_jwt_token","name":"Exchange current token for a new one","isWebhook":false,"pointer":"/paths/~1compliance~1auth~1token/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange current token for a new one","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/auth/token","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/compliance/auth/token","href":"auth/peach.security.handlers.compliance_renew_jwt_token","openApiOperationId":"peach.security.handlers.compliance_renew_jwt_token","summary":"Exchange current token for a new one","securityGroups":[{"oauth2":[]},{"bearerAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JWT token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}},"schemaId":"components/schemas/AuthSuccess"}],"pointer":"/paths/~1compliance~1auth~1token/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthSuccess"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.compliance_renew_jwt_token"}],"panels":[]}]},"httpPath":"/compliance/auth/token"},{"label":"Replace user's auth based on configured company auth type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.user_auth_replace","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.user_auth_replace","metadata":{"seo":{"title":"Replace user's auth based on configured company auth type","description":"Replace the user's authentication values from scratch. The authentication type is derived from the company config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.handlers.user_auth_replace","name":"Replace user's auth based on configured company auth type","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1auth/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace user's auth based on configured company auth type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replace the user's authentication values from scratch. The\nauthentication type is derived from the company config.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user.auth:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}~1auth/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewAuth"}},"schemaId":"components/schemas/NewAuth","pointer":"/paths/~1users~1{userId}~1auth/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}/auth","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user.auth:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewAuth"}},"responseCodes":["200"],"pointer":"/users/{userId}/auth","href":"auth/peach.security.handlers.user_auth_replace","openApiOperationId":"peach.security.handlers.user_auth_replace","summary":"Replace user's auth based on configured company auth type","securityGroups":[{"oauth2":["user.auth:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NewAuth","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewAuth"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5626"}},"schemaId":"schema_5626"}],"pointer":"/paths/~1users~1{userId}~1auth/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth/peach.security.handlers.user_auth_replace"}],"panels":[]}]},"httpPath":"/users/{userId}/auth"}],"content":{"contentType":"group","meta":{"name":"Auth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth","showPageActions":true},{"nodeType":"markdoc","content":"Authentication and authorization related endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/exchange-token","summary":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.exchange_token_create","deprecated":false},{"title":"/auth/password","summary":"Change password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.password_post","deprecated":false},{"title":"/auth/permissions","summary":"Get all permissions for the requesting user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/peach.security.handlers.permissions_get","deprecated":false},{"title":"/auth/token","summary":"End login session, invalidating current login token.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/auth/peach.security.handlers.logout","deprecated":false},{"title":"/auth/token","summary":"Exchange username and password for JWT token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.validate_and_send_token","deprecated":false},{"title":"/auth/token","summary":"Exchange current token for a new one","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth/peach.security.handlers.renew_jwt_token","deprecated":false},{"title":"/auth/token/short-lived","summary":"Create a short-lived token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.short_lived_token","deprecated":false},{"title":"/auth/user","summary":"Get logged-in user's info.\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/peach.security.handlers.user_info_get","deprecated":false},{"title":"/companies/{companyId}/auth/saml/callback","summary":"SAML callback endpoint\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.saml_sp_auth.idp_initiated","deprecated":false},{"title":"/companies/{companyId}/auth/saml/help","summary":"Display IdP setup help\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/peach.security.handlers.saml_sp_auth.idp_setup_help","deprecated":false},{"title":"/companies/{companyId}/auth/saml/login","summary":"Redirect to the SAML login endpoint\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/peach.security.handlers.saml_sp_auth.sp_initiated","deprecated":false},{"title":"/companies/{companyId}/auth/saml/metadata.xml","summary":"Display Peach SP Metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","deprecated":false},{"title":"/companies/{companyId}/auth/send-one-time-code","summary":"Send one time code.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.send_one_time_code","deprecated":false},{"title":"/compliance/auth/token","summary":"End login session, invalidating current login token.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/auth/peach.security.handlers.compliance_logout","deprecated":false},{"title":"/compliance/auth/token","summary":"Exchange username and password for JWT token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth/peach.security.handlers.compliance_validate_and_send_token","deprecated":false},{"title":"/compliance/auth/token","summary":"Exchange current token for a new one","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth/peach.security.handlers.compliance_renew_jwt_token","deprecated":false},{"title":"/users/{userId}/auth","summary":"Replace user's auth based on configured company auth type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth/peach.security.handlers.user_auth_replace","deprecated":false}]}]}]}]}},{"type":"group","label":"API Keys","link":"/api-docs/api-public/api-keys","routeSlug":"/api-docs/api-public/api-keys","items":[{"label":"Get all API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","metadata":{"seo":{"title":"Get all API keys","description":"Get all API keys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.api_keys.handlers.company_api_keys_get_all","name":"Get all API keys","isWebhook":false,"pointer":"/paths/~1keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["company.keys:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5627"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."}],"pointer":"/paths/~1keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/keys","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_5627"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["company.keys:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/keys","href":"api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","openApiOperationId":"peach.security.api_keys.handlers.company_api_keys_get_all","summary":"Get all API keys","securityGroups":[{"oauth2":["company.keys:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5630"}},"schemaId":"schema_5630"}],"pointer":"/paths/~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5630","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5630"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all"}],"panels":[]}]},"httpPath":"/keys"},{"label":"Create an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_create","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_create","metadata":{"seo":{"title":"Create an API key","description":"Create an API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.api_keys.handlers.company_api_key_create","name":"Create an API key","isWebhook":false,"pointer":"/paths/~1keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["company.keys:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyNoSecret"}},"schemaId":"components/schemas/RequestBodyAPIKeyNoSecret","pointer":"/paths/~1keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/keys","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["company.keys:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyNoSecret"}},"responseCodes":["201"],"pointer":"/keys","href":"api-keys/peach.security.api_keys.handlers.company_api_key_create","openApiOperationId":"peach.security.api_keys.handlers.company_api_key_create","summary":"Create an API key","securityGroups":[{"oauth2":["company.keys:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RequestBodyAPIKeyNoSecret","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyNoSecret"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}},"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}],"pointer":"/paths/~1keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResponseAPIKeyNoSecret","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/peach.security.api_keys.handlers.company_api_key_create"}],"panels":[]}]},"httpPath":"/keys"},{"label":"Delete an API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_delete","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_delete","metadata":{"seo":{"title":"Delete an API key","description":"Delete an API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.api_keys.handlers.company_api_key_delete","name":"Delete an API key","isWebhook":false,"pointer":"/paths/~1keys~1{keyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["company.keys:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"keyId","in":"path","schemaId":"components/schemas/newStatus","description":"The API key id.","required":true}],"pointer":"/paths/~1keys~1{keyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/keys/{keyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"keyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["company.keys:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/keys/{keyId}","href":"api-keys/peach.security.api_keys.handlers.company_api_key_delete","openApiOperationId":"peach.security.api_keys.handlers.company_api_key_delete","summary":"Delete an API key","securityGroups":[{"oauth2":["company.keys:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1keys~1{keyId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/peach.security.api_keys.handlers.company_api_key_delete"}],"panels":[]}]},"httpPath":"/keys/{keyId}"},{"label":"Get an API key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_get","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_get","metadata":{"seo":{"title":"Get an API key","description":"Get an API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.api_keys.handlers.company_api_key_get","name":"Get an API key","isWebhook":false,"pointer":"/paths/~1keys~1{keyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["company.keys:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"keyId","in":"path","schemaId":"components/schemas/newStatus","description":"The API key id.","required":true}],"pointer":"/paths/~1keys~1{keyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/keys/{keyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"keyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["company.keys:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/keys/{keyId}","href":"api-keys/peach.security.api_keys.handlers.company_api_key_get","openApiOperationId":"peach.security.api_keys.handlers.company_api_key_get","summary":"Get an API key","securityGroups":[{"oauth2":["company.keys:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}},"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}],"pointer":"/paths/~1keys~1{keyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseAPIKeyNoSecret","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecret"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/peach.security.api_keys.handlers.company_api_key_get"}],"panels":[]}]},"httpPath":"/keys/{keyId}"},{"label":"Update an API key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_update","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_update","metadata":{"seo":{"title":"Update an API key","description":"Update an API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.security.api_keys.handlers.company_api_key_update","name":"Update an API key","isWebhook":false,"pointer":"/paths/~1keys~1{keyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["company.keys:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"keyId","in":"path","schemaId":"components/schemas/newStatus","description":"The API key id.","required":true}],"pointer":"/paths/~1keys~1{keyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning"}},"schemaId":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning","pointer":"/paths/~1keys~1{keyId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/keys/{keyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"keyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["company.keys:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning"}},"responseCodes":["200"],"pointer":"/keys/{keyId}","href":"api-keys/peach.security.api_keys.handlers.company_api_key_update","openApiOperationId":"peach.security.api_keys.handlers.company_api_key_update","summary":"Update an API key","securityGroups":[{"oauth2":["company.keys:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecretAPIVersioning"}},"schemaId":"components/schemas/ResponseAPIKeyNoSecretAPIVersioning"}],"pointer":"/paths/~1keys~1{keyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseAPIKeyNoSecretAPIVersioning","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAPIKeyNoSecretAPIVersioning"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/peach.security.api_keys.handlers.company_api_key_update"}],"panels":[]}]},"httpPath":"/keys/{keyId}"}],"content":{"contentType":"group","meta":{"name":"API Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Keys","showPageActions":true},{"nodeType":"markdoc","content":"API Keys can be managed with these endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/keys","summary":"Get all API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","deprecated":false},{"title":"/keys","summary":"Create an API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/peach.security.api_keys.handlers.company_api_key_create","deprecated":false},{"title":"/keys/{keyId}","summary":"Delete an API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-keys/peach.security.api_keys.handlers.company_api_key_delete","deprecated":false},{"title":"/keys/{keyId}","summary":"Get an API key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/peach.security.api_keys.handlers.company_api_key_get","deprecated":false},{"title":"/keys/{keyId}","summary":"Update an API key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-keys/peach.security.api_keys.handlers.company_api_key_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Borrower Management","content":null},{"type":"group","label":"Borrowers","link":"/api-docs/api-public/borrowers","routeSlug":"/api-docs/api-public/borrowers","items":[{"label":"Get borrowers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list","metadata":{"seo":{"title":"Get borrowers","description":"Get borrowers filtering with optional parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.borrowers_list","name":"Get borrowers","isWebhook":false,"pointer":"/paths/~1people/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrowers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get borrowers filtering with optional parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_5631","description":"Status of borrower(s)."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"borrowerType","in":"query","schemaId":"schema_5633","description":"Exactly match the type of borrower."},{"name":"ids","in":"query","schemaId":"schema_5632","description":"List of IDs."}],"pointer":"/paths/~1people/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"},{"name":"status","in":"query","schemaId":"schema_5631"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"borrowerType","in":"query","schemaId":"schema_5633"},{"name":"ids","in":"query","schemaId":"schema_5632","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people","href":"borrowers/peach.people.handlers.borrowers_list","openApiOperationId":"peach.people.handlers.borrowers_list","summary":"Get borrowers","securityGroups":[{"oauth2":["person:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerPaging"}},"schemaId":"components/schemas/BorrowerPaging"}],"pointer":"/paths/~1people/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BorrowerPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/borrowers/peach.people.handlers.borrowers_list"}],"panels":[]}]},"httpPath":"/people"},{"label":"Create borrower","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_create","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_create","metadata":{"seo":{"title":"Create borrower","description":"Create a new borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.borrower_create","name":"Create borrower","isWebhook":false,"pointer":"/paths/~1people/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create borrower","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Borrower"}},"schemaId":"components/schemas/Borrower","pointer":"/paths/~1people/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Borrower"}},"responseCodes":["200"],"pointer":"/people","href":"borrowers/peach.people.handlers.borrower_create","openApiOperationId":"peach.people.handlers.borrower_create","summary":"Create borrower","securityGroups":[{"oauth2":["person:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Borrower","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Borrower"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5634"}},"schemaId":"schema_5634"}],"pointer":"/paths/~1people/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5634","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5634"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/borrowers/peach.people.handlers.borrower_create"}],"panels":[]}]},"httpPath":"/people"},{"label":"Search borrowers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_search","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_search","metadata":{"seo":{"title":"Search borrowers","description":"Search for borrowers. Returns same resourcesas /people."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.borrower_search","name":"Search borrowers","isWebhook":false,"pointer":"/paths/~1people~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search borrowers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for borrowers. Returns same resources"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/people"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person:search"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"_hasTheWords","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exact-matchable search fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_hasTheWords=Rob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Robby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Roberts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and street address of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123 Robinson Dr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"_notTheWords","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exact-matchable search fields, and ensure that entries matching that search will not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appear in results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_notTheWords=Rob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Robby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Roberts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and street address of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123 Robinson Dr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ensure those results are not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"included in results."},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fuzzy matches addresses associated with a borrower. For example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address=fake"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123 Fake St"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as well as a city of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fakeville"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that states are stored as their abbreviations, so you "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the abbreviation to match. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address=MO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match Missouri, but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address=Missouri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not."},"children":[]}]}]}]},{"name":"bankruptcyCourtCase","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly matches a bankruptcy court case ID.\n"},{"name":"borrowerType","in":"query","schemaId":"schema_5633","description":"Exactly match the type of borrower."},{"name":"businessName","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fuzzy matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessLegalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of business borrowers—never matches a person."},"children":[]}]}]}]},{"name":"caseId","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a case ID. Can be either the Peach ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CS-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the external ID."},"children":[]}]}]}]},{"name":"city","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy match the city in any of a borrower's addresses.\n"},{"name":"dateOfBirth","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a borrower's date of birth. Specified like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"email","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches any of a borrower's email addresses.\n"},{"name":"emailExact","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly matches any of a borrower's email addresses.\n"},{"name":"employeeEmail","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches any of a business borrower's employees' email addresses.\n"},{"name":"employeeEmailExact","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly matches any of a business borrower's employees' email addresses.\n"},{"name":"employeePhone","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches any of a business borrower's employees' phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that Peach currently only supports US phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may search with any US phone number format. For example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(570)123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+15701231234"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are all treated as identical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"570-123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers."},"children":[]}]}]}]},{"name":"employeeName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches a business borrower's employee's name. This will never match a person borrower.\n"},{"name":"firstName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches a borrower's first name.\n"},{"name":"firstNamePartial","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a substring of the borrower's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a borrower's first name were 'William',"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial=Will"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would match because it is exactly contained in the first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial=lia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would match because it is exactly contained in the first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial=Bill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would NOT match because, while close, it is not exactly contained in the first name."},"children":[]}]}]}]}]},{"name":"fullName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches all parts of a borrower's full name. (If the borrower is a business this will also\nmatch against the business name and business legal name.)\n"},{"name":"incorporatedState","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incorporatedState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of business borrowers."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a borrower's ID. Can be either the Peach ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the external ID."},"children":[]}]}]}]},{"name":"interactionId","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches the ID of an interaction sent to or receieved from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower. Can be either the Peach ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external ID."},"children":[]}]}]}],"example":"IN-1234-ABCD"},{"name":"lastName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches a borrower's last name.\n"},{"name":"lastNamePartial","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a substring of the borrower's last name, following the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same rules as for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"legalRepFirstName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy match the first name of any of a borrower's legal representatives.\n"},{"name":"legalRepLastName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy match the last name of any of a borrower's legal representatives.\n"},{"name":"legalRepEmail","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy match any email of any of a borrower's legal representatives.\n"},{"name":"legalRepPhone","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly match any phone number of any of a borrower's legal representatives."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that Peach currently only supports US phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may search with any US phone number format. For example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(570)123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+15701231234"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are all treated as identical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"570-123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers."},"children":[]}]}]}]},{"name":"loanId","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a loan's ID. Can be either the Peach ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LN-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the external ID."},"children":[]}]}]}],"example":"LN-1234-ABCD"},{"name":"loanIdPartial","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a substring of the loan's external ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a loan's external ID were "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6eeab840-3cbc-4c40-a19b-df3e9c040a54"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIdPartial=6eeab840"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would match because it is exactly contained in the external ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIdPartial=cbc-4c40-a1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would match because it is exactly contained in the external ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIdPartial=9bdf3e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would NOT match because, while close, it is not exactly contained in the external ID."},"children":[]}]}]}]}],"example":null},{"name":"maidenName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches a borrower's maiden name.\n"},{"name":"maidenNamePartial","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a substring of the borrower's maiden name, following the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same rules as for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"middleName","in":"query","schemaId":"components/schemas/newStatus","description":"Fuzzy matches a borrower's middle name.\n"},{"name":"middleNamePartial","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches a substring of the borrower's middle name, following the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same rules as for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstNamePartial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"paymentMethod","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly match the last four digits of the borrower's payment methods on file.\n"},{"name":"phone","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches any of a borrower's phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that Peach currently only supports US phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may search with any US phone number format. For example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(570)123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+15701231234"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are all treated as identical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"570-123-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers."},"children":[]}]}]}]},{"name":"postalCode","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly match the postal code in any of a borrower's addresses.\n"},{"name":"state","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly match the state (as an abbreviation) for any of a borrower's addresses.\n\nNote that the full name of a state will NOT match.\n"},{"name":"taxId","in":"query","schemaId":"components/schemas/newStatus","description":"Exactly matches the last four digits of any of the borrower's tax ID document numbers.\nThe Tax ID document is either a Social Security Number (SSN), an Individual Taxpayer\nIdentification Number (ITIN), or a passport number.\n"},{"name":"_forceIndex","in":"query","schemaId":"components/schemas/newStatus","description":"For testing new search systems before wider deploy, specify the index to use for searching.\n"}],"pointer":"/paths/~1people~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/search","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"_hasTheWords","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"_notTheWords","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"address","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"bankruptcyCourtCase","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"borrowerType","in":"query","schemaId":"schema_5633"},{"name":"businessName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"city","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"dateOfBirth","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"email","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"emailExact","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"employeeEmail","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"employeeEmailExact","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"employeePhone","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"employeeName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"firstName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"firstNamePartial","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"fullName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"incorporatedState","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"id","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"interactionId","in":"query","required":false,"example":"IN-1234-ABCD","schemaId":"components/schemas/newStatus"},{"name":"lastName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"lastNamePartial","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"legalRepFirstName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"legalRepLastName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"legalRepEmail","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"legalRepPhone","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"loanId","in":"query","required":false,"example":"LN-1234-ABCD","schemaId":"components/schemas/newStatus"},{"name":"loanIdPartial","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"maidenName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"maidenNamePartial","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"middleName","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"middleNamePartial","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"paymentMethod","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"phone","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"postalCode","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"state","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"taxId","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"_forceIndex","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person:search"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/search","href":"borrowers/peach.people.handlers.borrower_search","openApiOperationId":"peach.people.handlers.borrower_search","summary":"Search borrowers","securityGroups":[{"oauth2":["person:search"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonSearchPaging"}},"schemaId":"components/schemas/PersonSearchPaging"}],"pointer":"/paths/~1people~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonSearchPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonSearchPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/borrowers/peach.people.handlers.borrower_search"}],"panels":[]}]},"httpPath":"/people/search"},{"label":"Get borrower by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_get","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_get","metadata":{"seo":{"title":"Get borrower by ID","description":"Get an existing borrower by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.borrower_get","name":"Get borrower by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrower by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an existing borrower by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeIdentity","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, includes the primary identity of the borrower. Use of this flag requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"includeIdentity","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}","href":"borrowers/peach.people.handlers.borrower_get","openApiOperationId":"peach.people.handlers.borrower_get","summary":"Get borrower by ID","securityGroups":[{"oauth2":["person:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5634"}},"schemaId":"schema_5634"}],"pointer":"/paths/~1people~1{personId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5634","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5634"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/borrowers/peach.people.handlers.borrower_get"}],"panels":[]}]},"httpPath":"/people/{personId}"},{"label":"Update borrower","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_update","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_update","metadata":{"seo":{"title":"Update borrower","description":"Update an existing borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.borrower_update","name":"Update borrower","isWebhook":false,"pointer":"/paths/~1people~1{personId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update borrower","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing borrower."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5635"}},"schemaId":"schema_5635","pointer":"/paths/~1people~1{personId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5635"}},"responseCodes":["200"],"pointer":"/people/{personId}","href":"borrowers/peach.people.handlers.borrower_update","openApiOperationId":"peach.people.handlers.borrower_update","summary":"Update borrower","securityGroups":[{"oauth2":["person:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5635","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5635"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5636"}},"schemaId":"schema_5636"}],"pointer":"/paths/~1people~1{personId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5636","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5636"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/borrowers/peach.people.handlers.borrower_update"}],"panels":[]}]},"httpPath":"/people/{personId}"}],"content":{"contentType":"group","meta":{"name":"Borrowers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Borrowers","showPageActions":true},{"nodeType":"markdoc","content":"The Borrower object represents a borrower.\nIt allows you to maintain different statuses that are associated with the same borrower.\nThe API allows you to create, delete and update your borrowers. You can retrieve\nan individual borrower as well as a list of all your borrowers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people","summary":"Get borrowers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/borrowers/peach.people.handlers.borrowers_list","deprecated":false},{"title":"/people","summary":"Create borrower","prefix":{"name":"post","color":"post"},"badges":[],"link":"/borrowers/peach.people.handlers.borrower_create","deprecated":false},{"title":"/people/search","summary":"Search borrowers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/borrowers/peach.people.handlers.borrower_search","deprecated":false},{"title":"/people/{personId}","summary":"Get borrower by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/borrowers/peach.people.handlers.borrower_get","deprecated":false},{"title":"/people/{personId}","summary":"Update borrower","prefix":{"name":"put","color":"put"},"badges":[],"link":"/borrowers/peach.people.handlers.borrower_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Identity","link":"/api-docs/api-public/identity","routeSlug":"/api-docs/api-public/identity","items":[{"label":"Get identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.list_identities","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.list_identities","metadata":{"seo":{"title":"Get identities","description":"Get identities"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.list_identities","name":"Get identities","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get identities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"If set to true, includes archived identities\n"}],"pointer":"/paths/~1people~1{personId}~1identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/identities","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"includeArchived","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/identities","href":"identity/peach.people.handlers.list_identities","openApiOperationId":"peach.people.handlers.list_identities","summary":"Get identities","securityGroups":[{"oauth2":["person.identity:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityPaging"}},"schemaId":"components/schemas/IdentityPaging"}],"pointer":"/paths/~1people~1{personId}~1identities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.list_identities"}],"panels":[]}]},"httpPath":"/people/{personId}/identities"},{"label":"Create identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.create_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.create_identity","metadata":{"seo":{"title":"Create identity","description":"Create identity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.create_identity","name":"Create identity","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5637"}},"schemaId":"schema_5637","pointer":"/paths/~1people~1{personId}~1identities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/identities","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5637"}},"responseCodes":["200"],"pointer":"/people/{personId}/identities","href":"identity/peach.people.handlers.create_identity","openApiOperationId":"peach.people.handlers.create_identity","summary":"Create identity","securityGroups":[{"oauth2":["person.identity:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5637","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5637"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}},"schemaId":"schema_5638"}],"pointer":"/paths/~1people~1{personId}~1identities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.create_identity"}],"panels":[]}]},"httpPath":"/people/{personId}/identities"},{"label":"Archive identity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.delete_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.delete_identity","metadata":{"seo":{"title":"Archive identity","description":"Primary identities cannot be archived."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.delete_identity","name":"Archive identity","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Primary identities cannot be archived."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"personIdentityId","in":"path","schemaId":"components/schemas/newStatus","description":"An identity's unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"caseId","in":"query","schemaId":"schema_5625","description":"Optional case ID to be recorded with the change.\n"}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/identities/{personIdentityId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"personIdentityId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"caseId","in":"query","schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/identities/{personIdentityId}","href":"identity/peach.people.handlers.delete_identity","openApiOperationId":"peach.people.handlers.delete_identity","summary":"Archive identity","securityGroups":[{"oauth2":["person.identity:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.delete_identity"}],"panels":[]}]},"httpPath":"/people/{personId}/identities/{personIdentityId}"},{"label":"Get identity by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.get_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.get_identity","metadata":{"seo":{"title":"Get identity by ID","description":"Get identity by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.get_identity","name":"Get identity by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get identity by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"personIdentityId","in":"path","schemaId":"components/schemas/newStatus","description":"An identity's unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/identities/{personIdentityId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"personIdentityId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/identities/{personIdentityId}","href":"identity/peach.people.handlers.get_identity","openApiOperationId":"peach.people.handlers.get_identity","summary":"Get identity by ID","securityGroups":[{"oauth2":["person.identity:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}},"schemaId":"schema_5638"}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.get_identity"}],"panels":[]}]},"httpPath":"/people/{personId}/identities/{personIdentityId}"},{"label":"Update identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.update_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.update_identity","metadata":{"seo":{"title":"Update identity","description":"For primary identities, the isArchived field cannot be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.update_identity","name":"Update identity","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For primary identities, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isArchived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"personIdentityId","in":"path","schemaId":"components/schemas/newStatus","description":"An identity's unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5639"}},"schemaId":"schema_5639","pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/identities/{personIdentityId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"personIdentityId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5639"}},"responseCodes":["200"],"pointer":"/people/{personId}/identities/{personIdentityId}","href":"identity/peach.people.handlers.update_identity","openApiOperationId":"peach.people.handlers.update_identity","summary":"Update identity","securityGroups":[{"oauth2":["person.identity:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5639","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5639"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}},"schemaId":"schema_5638"}],"pointer":"/paths/~1people~1{personId}~1identities~1{personIdentityId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.update_identity"}],"panels":[]}]},"httpPath":"/people/{personId}/identities/{personIdentityId}"},{"label":"Get primary identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.get_primary_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.get_primary_identity","metadata":{"seo":{"title":"Get primary identity","description":"Get primary identity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.get_primary_identity","name":"Get primary identity","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1identity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get primary identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["person.identity:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1identity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/identity","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["person.identity:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/identity","href":"identity/peach.people.handlers.get_primary_identity","openApiOperationId":"peach.people.handlers.get_primary_identity","summary":"Get primary identity","securityGroups":[{"oauth2":["person.identity:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}},"schemaId":"schema_5638"}],"pointer":"/paths/~1people~1{personId}~1identity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5638"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity/peach.people.handlers.get_primary_identity"}],"panels":[]}]},"httpPath":"/people/{personId}/identity"}],"content":{"contentType":"group","meta":{"name":"Identity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity","showPageActions":true},{"nodeType":"markdoc","content":"Identity objects represent various forms of identification that a borrower may have.\nWe allow one primary identity per borrower, and any number of secondary identities.\nThe identity sent when creating a borrower is the primary identity, and cannot be\ndeleted/archived or changed to be a secondary identity."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/identities","summary":"Get identities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identity/peach.people.handlers.list_identities","deprecated":false},{"title":"/people/{personId}/identities","summary":"Create identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identity/peach.people.handlers.create_identity","deprecated":false},{"title":"/people/{personId}/identities/{personIdentityId}","summary":"Archive identity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/identity/peach.people.handlers.delete_identity","deprecated":false},{"title":"/people/{personId}/identities/{personIdentityId}","summary":"Get identity by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identity/peach.people.handlers.get_identity","deprecated":false},{"title":"/people/{personId}/identities/{personIdentityId}","summary":"Update identity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/identity/peach.people.handlers.update_identity","deprecated":false},{"title":"/people/{personId}/identity","summary":"Get primary identity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identity/peach.people.handlers.get_primary_identity","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Information","link":"/api-docs/api-public/contact-information","routeSlug":"/api-docs/api-public/contact-information","items":[{"label":"List contact for borrower","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.list_contacts_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.list_contacts_for_borrower","metadata":{"seo":{"title":"List contact for borrower","description":"List contacts for a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.list_contacts_for_borrower","name":"List contact for borrower","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contact for borrower","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List contacts for a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"collidesWithEmail","in":"query","schemaId":"components/schemas/newStatus","description":"Filters for contacts which would collide with this email if it were used\nto create a new borrower contact.\n"},{"name":"collidesWithPhone","in":"query","schemaId":"components/schemas/newStatus","description":"Filters for contacts which would collide with this phone number if it were used\nto create a new borrower contact.\n"},{"name":"contactType","in":"query","schemaId":"schema_5640","description":"The contact type to filter by."},{"name":"affiliation","in":"query","schemaId":"schema_5641","description":"The contact affiliation to filter by."},{"name":"label","in":"query","schemaId":"schema_5642","description":"The contact label to filter by."},{"name":"status","in":"query","schemaId":"schema_5643","description":"The contact status to filter by."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived contacts into the result."},{"name":"includeLegal","in":"query","schemaId":"schema_5644","description":"Whether to include legal representation contact objects.\n"},{"name":"receiveTextMessages","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If passed, only returns contacts with receiveTextMessages set to that value."},{"name":"value","in":"query","schemaId":"components/schemas/newStatus","description":"The value of the contact to filter by."},{"name":"powerOfAttorney","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If passed, only returns contacts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"powerOfAttorney"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to that value."},"children":[]}]}]}]},{"name":"authorizedThirdParty","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If passed, only returns contacts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedThirdParty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to that value."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/contacts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"collidesWithEmail","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"collidesWithPhone","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"contactType","in":"query","required":false,"schemaId":"components/schemas/ContactType"},{"name":"affiliation","in":"query","schemaId":"components/schemas/ContactAffiliation"},{"name":"label","in":"query","schemaId":"components/schemas/ContactLabel"},{"name":"status","in":"query","schemaId":"components/schemas/ContactStatus"},{"name":"includeArchived","in":"query","schemaId":"schema_5623"},{"name":"includeLegal","in":"query","schemaId":"schema_5644"},{"name":"receiveTextMessages","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"value","in":"query","schemaId":"components/schemas/newStatus"},{"name":"powerOfAttorney","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"authorizedThirdParty","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/contacts","href":"contact-information/peach.people.contact.handlers.list_contacts_for_borrower","openApiOperationId":"peach.people.contact.handlers.list_contacts_for_borrower","summary":"List contact for borrower","securityGroups":[{"oauth2":["contact:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5645"}},"schemaId":"schema_5645"}],"pointer":"/paths/~1people~1{personId}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5645","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5645"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.list_contacts_for_borrower"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts"},{"label":"Create contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.create_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.create_contact_for_borrower","metadata":{"seo":{"title":"Create contact","description":"Create contact for a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.create_contact_for_borrower","name":"Create contact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create contact for a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."},{"name":"confirmationCode","in":"query","schemaId":"schema_5646","description":"The previously emailed or texted confirmation code."}],"pointer":"/paths/~1people~1{personId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"schemaId":"components/schemas/ContactInformation","pointer":"/paths/~1people~1{personId}~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/contacts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"},{"name":"confirmationCode","in":"query","required":false,"schemaId":"schema_5646"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"responseCodes":["200","429"],"pointer":"/people/{personId}/contacts","href":"contact-information/peach.people.contact.handlers.create_contact_for_borrower","openApiOperationId":"peach.people.contact.handlers.create_contact_for_borrower","summary":"Create contact","securityGroups":[{"oauth2":["contact:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/ContactInformation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}},"schemaId":"schema_5647"},{"code":"429","description":"Too many incorrect confirmation code attempts were made for this contact. The active\nconfirmation code can no longer be used; request a new confirmation code and try again.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}},"schemaId":"schema_5648"}],"pointer":"/paths/~1people~1{personId}~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5647","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}}},{"code":"429","schemaId":"schema_5648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.create_contact_for_borrower"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts"},{"label":"Delete contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.delete_contact","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.delete_contact","metadata":{"seo":{"title":"Delete contact","description":"Delete a borrower's contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.delete_contact","name":"Delete contact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a borrower's contact.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"contactId","in":"path","schemaId":"schema_5625","description":"The contact ID.","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/contacts/{contactId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"contactId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/contacts/{contactId}","href":"contact-information/peach.people.contact.handlers.delete_contact","openApiOperationId":"peach.people.contact.handlers.delete_contact","summary":"Delete contact","securityGroups":[{"oauth2":["contact:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.delete_contact"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts/{contactId}"},{"label":"Get contact by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.get_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.get_contact_for_borrower","metadata":{"seo":{"title":"Get contact by ID","description":"Get contact by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.get_contact_for_borrower","name":"Get contact by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contact by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"contactId","in":"path","schemaId":"schema_5625","description":"The contact ID.","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/contacts/{contactId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"contactId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/contacts/{contactId}","href":"contact-information/peach.people.contact.handlers.get_contact_for_borrower","openApiOperationId":"peach.people.contact.handlers.get_contact_for_borrower","summary":"Get contact by ID","securityGroups":[{"oauth2":["contact:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}},"schemaId":"schema_5647"}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5647","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.get_contact_for_borrower"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts/{contactId}"},{"label":"Update contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.update_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.update_contact_for_borrower","metadata":{"seo":{"title":"Update contact","description":"Update contact of a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.update_contact_for_borrower","name":"Update contact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update contact of a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"contactId","in":"path","schemaId":"schema_5625","description":"The contact ID.","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"confirmationCode","in":"query","schemaId":"schema_5646","description":"The previously emailed or texted confirmation code."},{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"schemaId":"components/schemas/ContactInformation","pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/contacts/{contactId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"contactId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"confirmationCode","in":"query","required":false,"schemaId":"schema_5646"},{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"responseCodes":["200","429"],"pointer":"/people/{personId}/contacts/{contactId}","href":"contact-information/peach.people.contact.handlers.update_contact_for_borrower","openApiOperationId":"peach.people.contact.handlers.update_contact_for_borrower","summary":"Update contact","securityGroups":[{"oauth2":["contact:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/ContactInformation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}},"schemaId":"schema_5647"},{"code":"429","description":"Too many incorrect confirmation code attempts were made for this contact. The active\nconfirmation code can no longer be used; request a new confirmation code and try again.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}},"schemaId":"schema_5648"}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5647","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}}},{"code":"429","schemaId":"schema_5648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.update_contact_for_borrower"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts/{contactId}"},{"label":"Clone contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.clone_contact","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.clone_contact","metadata":{"seo":{"title":"Clone contact","description":"Clones the borrower's contact information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact.handlers.clone_contact","name":"Clone contact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}~1clone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clones the borrower's contact information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This copies all properties from the existing contact and applies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the passed properties. Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing contact to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the existing contact to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the new contact with a new Peach ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contact:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"contactId","in":"path","schemaId":"schema_5625","description":"The contact ID.","required":true}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}~1clone/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"confirmationCode","in":"query","schemaId":"schema_5646","description":"The previously emailed or texted confirmation code."},{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}~1clone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"schemaId":"components/schemas/ContactInformation","pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}~1clone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/contacts/{contactId}/clone","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"contactId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"confirmationCode","in":"query","required":false,"schemaId":"schema_5646"},{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contact:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"responseCodes":["200","429"],"pointer":"/people/{personId}/contacts/{contactId}/clone","href":"contact-information/peach.people.contact.handlers.clone_contact","openApiOperationId":"peach.people.contact.handlers.clone_contact","summary":"Clone contact","securityGroups":[{"oauth2":["contact:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/ContactInformation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactInformation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}},"schemaId":"schema_5647"},{"code":"429","description":"Too many incorrect confirmation code attempts were made for this contact. The active\nconfirmation code can no longer be used; request a new confirmation code and try again.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}},"schemaId":"schema_5648"}],"pointer":"/paths/~1people~1{personId}~1contacts~1{contactId}~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5647","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5647"}}},{"code":"429","schemaId":"schema_5648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5648"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-information/peach.people.contact.handlers.clone_contact"}],"panels":[]}]},"httpPath":"/people/{personId}/contacts/{contactId}/clone"}],"content":{"contentType":"group","meta":{"name":"Contact Information"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Information","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to add and manage a Borrower's contact information. A Borrower can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have an \"unlimited\" number of contacts. However, it is important to properly create key contact objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach Borrower Portal (if used by the lender), shows the following contacts only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contactType=email, label=personal or work, affiliation=self, status=primary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE PHONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contactType=phone, label=personal, affiliation=self, status=primary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HOME PHONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contactType=phone, label=home, affiliation=self, status=secondary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HOME ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contactType=address, label=home, affiliation=self, status=primary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach system sends notices (e.g. payment reminder) to borrowers (if configured by the lender)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order for a notice to be sent successfully, both contact object and template must exist."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a contact cannot be found, the system will not send a notice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will try to find the following contact objects:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email notices:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contactType=email, valid=true, affiliation=self, status=primary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(if \"primary\" is not found, the system searches for \"secondary\" and then for \"additional\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text message/SMS notices:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contactType=phone, valid=true, affiliation=self, receiveTextMessages=true, label=personal, status=primary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(if \"primary\" is not found, the system searches for \"secondary\" and then for \"additional\")"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/contacts","summary":"List contact for borrower","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.list_contacts_for_borrower","deprecated":false},{"title":"/people/{personId}/contacts","summary":"Create contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.create_contact_for_borrower","deprecated":false},{"title":"/people/{personId}/contacts/{contactId}","summary":"Delete contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.delete_contact","deprecated":false},{"title":"/people/{personId}/contacts/{contactId}","summary":"Get contact by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.get_contact_for_borrower","deprecated":false},{"title":"/people/{personId}/contacts/{contactId}","summary":"Update contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.update_contact_for_borrower","deprecated":false},{"title":"/people/{personId}/contacts/{contactId}/clone","summary":"Clone contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-information/peach.people.contact.handlers.clone_contact","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Instruments","link":"/api-docs/api-public/payment-instruments","routeSlug":"/api-docs/api-public/payment-instruments","items":[{"label":"Get payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","metadata":{"seo":{"title":"Get payment instruments","description":"Get payment instruments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_get_all","name":"Get payment instruments","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isExternal","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Fetch entities that are marked external."},{"name":"includeDeleted","in":"query","schemaId":"schema_5623","description":"Include entities that are marked deleted."},{"name":"showFullAccountNumber","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide raw untokenized account details:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cards, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for bank accounts, checks, wires, and money orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/payment-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"isExternal","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"includeDeleted","in":"query","schemaId":"schema_5623"},{"name":"showFullAccountNumber","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_get_all","summary":"Get payment instruments","securityGroups":[{"oauth2":["payment.instrument:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment Instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5649"}},"schemaId":"schema_5649"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5649","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5649"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments"},{"label":"Create payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","metadata":{"seo":{"title":"Create payment instrument","description":"Create a payment instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_create","name":"Create payment instrument","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment instrument using the Plaid Account option, two flows are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This will create a payment instrument with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can then use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"./payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update"},"href":"./payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update payment instrument"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the required fields as well as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This will create a payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrument with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment instrument will then be ready to use."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This endpoint returns an array containing a single payment instrument to allow future support for Plaid multi-account select."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides the results of BIN / Routing Number lookup. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the payment instrument authentication process synchronous. Only relevant for cards.\n"},{"name":"allowDuplicates","in":"query","schemaId":"schema_5623","description":"For external payment instruments, skip duplicate checks. Allows the creation two external payment instruments with the same last 4 digits on the same borrower.\n"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentPost"}},"schemaId":"components/schemas/PaymentInstrumentPost","pointer":"/paths/~1people~1{personId}~1payment-instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/payment-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"force","in":"query","schemaId":"schema_5623"},{"name":"sync","in":"query","schemaId":"schema_5623"},{"name":"allowDuplicates","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentPost"}},"responseCodes":["201","409"],"pointer":"/people/{personId}/payment-instruments","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_create","summary":"Create payment instrument","securityGroups":[{"oauth2":["payment.instrument:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PaymentInstrumentPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment Instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5650"}},"schemaId":"schema_5650"},{"code":"409","description":"Duplicate instrument"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5650","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5650"}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments"},{"label":"Delete payment instrument","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","metadata":{"seo":{"title":"Delete payment instrument","description":"Delete payment instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_delete","name":"Delete payment instrument","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_delete","summary":"Delete payment instrument","securityGroups":[{"oauth2":["payment.instrument:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payment Instrument Deleted"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}"},{"label":"Get payment instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","metadata":{"seo":{"title":"Get payment instrument by ID","description":"Get payment instrument by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_get","name":"Get payment instrument by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment instrument by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"showFullAccountNumber","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide raw untokenized account details:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cards, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for bank accounts, checks, wires, and money orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"showFullAccountNumber","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_get","summary":"Get payment instrument by ID","securityGroups":[{"oauth2":["payment.instrument:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment Instrument","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5651"}},"schemaId":"schema_5651"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5651","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5651"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}"},{"label":"Update payment instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","metadata":{"seo":{"title":"Update payment instrument","description":"Update payment instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_update","name":"Update payment instrument","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the payment instrument authentication process synchronous. Only relevant for cards.\n"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5652"}},"schemaId":"schema_5652","pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5652"}},"responseCodes":["204"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_update","summary":"Update payment instrument","securityGroups":[{"oauth2":["payment.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5652","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5652"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payment Instrument Updated"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}"},{"label":"Delete account link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_delete","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_delete","metadata":{"seo":{"title":"Delete account link","description":"Retrieve the data vendor link details for this payment instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.account_link_delete","name":"Delete account link","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the data vendor link details for this payment instrument."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","href":"payment-instruments/peach.payment_instruments.handlers.account_link_delete","openApiOperationId":"peach.payment_instruments.handlers.account_link_delete","summary":"Delete account link","securityGroups":[{"oauth2":["payment.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.account_link_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link"},{"label":"Create account link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_post","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_post","metadata":{"seo":{"title":"Create account link","description":"Add a data vendor link for this payment instrument. If one is already present, it is replaced."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.account_link_post","name":"Create account link","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a data vendor link for this payment instrument. If one is already present, it is replaced."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountLink"}},"schemaId":"components/schemas/AccountLink","pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountLink"}},"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","href":"payment-instruments/peach.payment_instruments.handlers.account_link_post","openApiOperationId":"peach.payment_instruments.handlers.account_link_post","summary":"Create account link","securityGroups":[{"oauth2":["payment.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AccountLink","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountLink"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Link created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5653"}},"schemaId":"schema_5653"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5653","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5653"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.account_link_post"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link"},{"label":"Update account link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_put","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_put","metadata":{"seo":{"title":"Update account link","description":"Update record keeping details about the account link. This can not be used to set up a new account link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.account_link_put","name":"Update account link","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update record keeping details about the account link. This can not be used to set up a new account link."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountLinkUpdate"}},"schemaId":"components/schemas/AccountLinkUpdate","pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountLinkUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","href":"payment-instruments/peach.payment_instruments.handlers.account_link_put","openApiOperationId":"peach.payment_instruments.handlers.account_link_put","summary":"Update account link","securityGroups":[{"oauth2":["payment.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AccountLinkUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountLinkUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Link updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5653"}},"schemaId":"schema_5653"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1account-link/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5653","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5653"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.account_link_put"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link"},{"label":"Get balance data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_get","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_get","metadata":{"seo":{"title":"Get balance data","description":"Get stored balance data for the account associated with the payment instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.balances_get","name":"Get balance data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get balance data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get stored balance data for the account associated with the payment instrument."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","href":"payment-instruments/peach.payment_instruments.handlers.balances_get","openApiOperationId":"peach.payment_instruments.handlers.balances_get","summary":"Get balance data","securityGroups":[{"oauth2":["payment.instrument:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5654"}},"schemaId":"schema_5654"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5654","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5654"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.balances_get"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance"},{"label":"Refresh balance data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_post","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_post","metadata":{"seo":{"title":"Refresh balance data","description":"Fetch updated balance data from the account link associated with this payment instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.balances_post","name":"Refresh balance data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh balance data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch updated balance data from the account link associated with this payment instrument."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update.balances"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update.balances"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","href":"payment-instruments/peach.payment_instruments.handlers.balances_post","openApiOperationId":"peach.payment_instruments.handlers.balances_post","summary":"Refresh balance data","securityGroups":[{"oauth2":["payment.instrument:update.balances"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5654"}},"schemaId":"schema_5654"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5654","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5654"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.balances_post"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance"},{"label":"Verify amounts of microdeposits","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","metadata":{"seo":{"title":"Verify amounts of microdeposits","description":"Verify amounts of microdeposits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.person_payment_instrument_verify","name":"Verify amounts of microdeposits","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify amounts of microdeposits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"paymentInstrumentId","in":"path","schemaId":"schema_5625","description":"The payment instrument identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5655"}},"schemaId":"schema_5655","pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/payment-instruments/{paymentInstrumentId}/verify","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5655"}},"responseCodes":["204"],"pointer":"/people/{personId}/payment-instruments/{paymentInstrumentId}/verify","href":"payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","openApiOperationId":"peach.payment_instruments.handlers.person_payment_instrument_verify","summary":"Verify amounts of microdeposits","securityGroups":[{"oauth2":["payment.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5655","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5655"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1payment-instruments~1{paymentInstrumentId}~1verify/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify"}],"panels":[]}]},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/verify"}],"content":{"contentType":"group","meta":{"name":"Payment Instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Instruments","showPageActions":true},{"nodeType":"markdoc","content":"This object represents a payment method (e.g. bank account, credit card, debit card, etc.) belonging to a borrower."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/payment-instruments","summary":"Get payment instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","deprecated":false},{"title":"/people/{personId}/payment-instruments","summary":"Create payment instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}","summary":"Delete payment instrument","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}","summary":"Get payment instrument by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}","summary":"Update payment instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","summary":"Delete account link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.account_link_delete","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","summary":"Create account link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.account_link_post","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","summary":"Update account link","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.account_link_put","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","summary":"Get balance data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.balances_get","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","summary":"Refresh balance data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.balances_post","deprecated":false},{"title":"/people/{personId}/payment-instruments/{paymentInstrumentId}/verify","summary":"Verify amounts of microdeposits","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","deprecated":false}]}]}]}]}},{"type":"group","label":"Consent","link":"/api-docs/api-public/consent","routeSlug":"/api-docs/api-public/consent","items":[{"label":"Get consents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/consent/peach.people.handlers.consent_get","routeSlug":"/api-docs/api-public/consent/peach.people.handlers.consent_get","metadata":{"seo":{"title":"Get consents","description":"Get all consent associated with a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.consent_get","name":"Get consents","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1consents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get consents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all consent associated with a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["consent:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1consents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/consents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["consent:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/consents","href":"consent/peach.people.handlers.consent_get","openApiOperationId":"peach.people.handlers.consent_get","summary":"Get consents","securityGroups":[{"oauth2":["consent:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentArray"}},"schemaId":"components/schemas/ConsentArray"}],"pointer":"/paths/~1people~1{personId}~1consents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentArray","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentArray"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent/peach.people.handlers.consent_get"}],"panels":[]}]},"httpPath":"/people/{personId}/consents"},{"label":"Update consents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/consent/peach.people.handlers.consent_update","routeSlug":"/api-docs/api-public/consent/peach.people.handlers.consent_update","metadata":{"seo":{"title":"Update consents","description":"Update the consents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.consent_update","name":"Update consents","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1consents/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update consents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the consents\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["consent:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1consents/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"caseId","in":"query","schemaId":"schema_5625","description":"Optional case ID to be recorded with the change.\n"}],"pointer":"/paths/~1people~1{personId}~1consents/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Consents"}},"schemaId":"components/schemas/Consents","pointer":"/paths/~1people~1{personId}~1consents/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/consents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"caseId","in":"query","schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["consent:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Consents"}},"responseCodes":["200"],"pointer":"/people/{personId}/consents","href":"consent/peach.people.handlers.consent_update","openApiOperationId":"peach.people.handlers.consent_update","summary":"Update consents","securityGroups":[{"oauth2":["consent:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Consents","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Consents"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentArray"}},"schemaId":"components/schemas/ConsentArray"}],"pointer":"/paths/~1people~1{personId}~1consents/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsentArray","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsentArray"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consent/peach.people.handlers.consent_update"}],"panels":[]}]},"httpPath":"/people/{personId}/consents"}],"content":{"contentType":"group","meta":{"name":"Consent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consent","showPageActions":true},{"nodeType":"markdoc","content":"Explicit consent to receive certain kinds of communications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/consents","summary":"Get consents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consent/peach.people.handlers.consent_get","deprecated":false},{"title":"/people/{personId}/consents","summary":"Update consents","prefix":{"name":"put","color":"put"},"badges":[],"link":"/consent/peach.people.handlers.consent_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents","link":"/api-docs/api-public/documents","routeSlug":"/api-docs/api-public/documents","items":[{"label":"Create new document via link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.create_document_via_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.create_document_via_link","metadata":{"seo":{"title":"Create new document via link","description":"Create new document via link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.documents_via_links.create_document_via_link","name":"Create new document via link","isWebhook":false,"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new document via link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentUploadLinkKey","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The doc upload link key. Used to perform document upload operations without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logging into Peach system. This should be treated as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because anyone"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in possession of this key can upload on behalf the borrower for which it was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentUploadLinkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"schemaId":"components/schemas/DocumentDescriptorCreate","pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents/post/requestBody","description":"The new document descriptor"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/document-uploads/{documentUploadLinkKey}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"documentUploadLinkKey","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"responseCodes":["200"],"pointer":"/document-uploads/{documentUploadLinkKey}/documents","href":"documents/peach.docustore.handlers.documents_via_links.create_document_via_link","openApiOperationId":"peach.docustore.handlers.documents_via_links.create_document_via_link","summary":"Create new document via link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DocumentDescriptorCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"}],"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.documents_via_links.create_document_via_link"}],"panels":[]}]},"httpPath":"/document-uploads/{documentUploadLinkKey}/documents"},{"label":"Upload document content via link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","metadata":{"seo":{"title":"Upload document content via link","description":"Upload document content via link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.documents_via_links.upload_document_content_via_link","name":"Upload document content via link","isWebhook":false,"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents~1{documentDescriptorId}~1content/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload document content via link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentUploadLinkKey","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The doc upload link key. Used to perform document upload operations without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logging into Peach system. This should be treated as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because anyone"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in possession of this key can upload on behalf the borrower for which it was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created. Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentUploadLinkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents~1{documentDescriptorId}~1content/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5656"}},"schemaId":"schema_5656","pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents~1{documentDescriptorId}~1content/post/requestBody","description":"The document content"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/document-uploads/{documentUploadLinkKey}/documents/{documentDescriptorId}/content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"documentUploadLinkKey","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_5656"}},"responseCodes":["201"],"pointer":"/document-uploads/{documentUploadLinkKey}/documents/{documentDescriptorId}/content","href":"documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","openApiOperationId":"peach.docustore.handlers.documents_via_links.upload_document_content_via_link","summary":"Upload document content via link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5656","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5656"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"}],"pointer":"/paths/~1document-uploads~1{documentUploadLinkKey}~1documents~1{documentDescriptorId}~1content/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link"}],"panels":[]}]},"httpPath":"/document-uploads/{documentUploadLinkKey}/documents/{documentDescriptorId}/content"},{"label":"Get document upload links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","metadata":{"seo":{"title":"Get document upload links","description":"Get document upload links"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.document_upload_links.get_document_upload_links","name":"Get document upload links","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1document-upload-links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document upload links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document-upload-link:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1document-upload-links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/document-upload-links","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document-upload-link:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/document-upload-links","href":"documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","openApiOperationId":"peach.docustore.handlers.document_upload_links.get_document_upload_links","summary":"Get document upload links","securityGroups":[{"oauth2":["document-upload-link:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5657"}},"schemaId":"schema_5657"}],"pointer":"/paths/~1people~1{personId}~1document-upload-links/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5657","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5657"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links"}],"panels":[]}]},"httpPath":"/people/{personId}/document-upload-links"},{"label":"Create document upload link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","metadata":{"seo":{"title":"Create document upload link","description":"Create document upload link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.document_upload_links.create_document_upload_link","name":"Create document upload link","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1document-upload-links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create document upload link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document-upload-link:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1document-upload-links/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}},"schemaId":"components/schemas/DocumentUploadLink","pointer":"/paths/~1people~1{personId}~1document-upload-links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/document-upload-links","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document-upload-link:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}},"responseCodes":["200"],"pointer":"/people/{personId}/document-upload-links","href":"documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","openApiOperationId":"peach.docustore.handlers.document_upload_links.create_document_upload_link","summary":"Create document upload link","securityGroups":[{"oauth2":["document-upload-link:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DocumentUploadLink","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}},"schemaId":"components/schemas/DocumentUploadLink"}],"pointer":"/paths/~1people~1{personId}~1document-upload-links/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentUploadLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link"}],"panels":[]}]},"httpPath":"/people/{personId}/document-upload-links"},{"label":"Get doc upload link by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","metadata":{"seo":{"title":"Get doc upload link by ID","description":"Get doc upload link by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.document_upload_links.get_document_upload_link","name":"Get doc upload link by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1document-upload-links~1{documentUploadLinkId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get doc upload link by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document-upload-link:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentUploadLinkId","in":"path","schemaId":"schema_5625","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The doc upload link ID. Used for identifying the resource in the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not to be confused with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentUploadLinkKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1people~1{personId}~1document-upload-links~1{documentUploadLinkId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/document-upload-links/{documentUploadLinkId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentUploadLinkId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document-upload-link:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/document-upload-links/{documentUploadLinkId}","href":"documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","openApiOperationId":"peach.docustore.handlers.document_upload_links.get_document_upload_link","summary":"Get doc upload link by ID","securityGroups":[{"oauth2":["document-upload-link:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}},"schemaId":"components/schemas/DocumentUploadLink"}],"pointer":"/paths/~1people~1{personId}~1document-upload-links~1{documentUploadLinkId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentUploadLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadLink"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link"}],"panels":[]}]},"httpPath":"/people/{personId}/document-upload-links/{documentUploadLinkId}"},{"label":"Get document descriptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.list_person_documents","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.list_person_documents","metadata":{"seo":{"title":"Get document descriptors","description":"Get document descriptors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.list_person_documents","name":"Get document descriptors","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document descriptors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_5658","description":"The document type to select by."},{"name":"loanId","in":"query","schemaId":"components/schemas/newStatus","description":"The loan identifier to select by."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived documents into the result"},{"name":"uploadedBy","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show documents that were uploaded by a specific user. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to show documents uploaded only by the borrower."},"children":[]}]}]}]},{"name":"autogenerated","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include documents which are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autogenerated == true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and likewise for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"isHumanBorrowerUpload","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only include documents which are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHumanBorrowerUpload == true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and likewise for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"type","in":"query","required":false,"schemaId":"schema_5658"},{"name":"loanId","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"uploadedBy","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"autogenerated","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"isHumanBorrowerUpload","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/documents","href":"documents/peach.docustore.handlers.list_person_documents","openApiOperationId":"peach.docustore.handlers.list_person_documents","summary":"Get document descriptors","securityGroups":[{"oauth2":["document:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5659"}},"schemaId":"schema_5659"}],"pointer":"/paths/~1people~1{personId}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.list_person_documents"}],"panels":[]}]},"httpPath":"/people/{personId}/documents"},{"label":"Create new document descriptor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.create_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.create_person_document","metadata":{"seo":{"title":"Create new document descriptor","description":"Create new document descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.create_person_document","name":"Create new document descriptor","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new document descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"schemaId":"components/schemas/DocumentDescriptorCreate","pointer":"/paths/~1people~1{personId}~1documents/post/requestBody","description":"The new document descriptor"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"responseCodes":["200","400"],"pointer":"/people/{personId}/documents","href":"documents/peach.docustore.handlers.create_person_document","openApiOperationId":"peach.docustore.handlers.create_person_document","summary":"Create new document descriptor","securityGroups":[{"oauth2":["document:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DocumentDescriptorCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.create_person_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents"},{"label":"Delete document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.delete_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.delete_document","metadata":{"seo":{"title":"Delete document","description":"Delete document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.delete_document","name":"Delete document","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/documents/{documentDescriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/documents/{documentDescriptorId}","href":"documents/peach.docustore.handlers.delete_document","openApiOperationId":"peach.docustore.handlers.delete_document","summary":"Delete document","securityGroups":[{"oauth2":["document:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.delete_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}"},{"label":"Get document descriptor by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.get_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.get_person_document","metadata":{"seo":{"title":"Get document descriptor by ID","description":"Get document descriptor by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.get_person_document","name":"Get document descriptor by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document descriptor by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/documents/{documentDescriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/documents/{documentDescriptorId}","href":"documents/peach.docustore.handlers.get_person_document","openApiOperationId":"peach.docustore.handlers.get_person_document","summary":"Get document descriptor by ID","securityGroups":[{"oauth2":["document:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.get_person_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}"},{"label":"Update document descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.update_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.update_person_document","metadata":{"seo":{"title":"Update document descriptor","description":"Update document descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.update_person_document","name":"Update document descriptor","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update document descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse","pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/put/requestBody","description":"Document descriptor fields"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/documents/{documentDescriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"responseCodes":["200","400"],"pointer":"/people/{personId}/documents/{documentDescriptorId}","href":"documents/peach.docustore.handlers.update_person_document","openApiOperationId":"peach.docustore.handlers.update_person_document","summary":"Update document descriptor","securityGroups":[{"oauth2":["document:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.update_person_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}"},{"label":"Download document content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.download_person_document_content","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.download_person_document_content","metadata":{"seo":{"title":"Download document content","description":"Download document content"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.download_person_document_content","name":"Download document content","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download document content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]},{"schemes":[{"name":"bearerAuthQuery","scopes":[],"type":"apiKey","in":"query","paramName":"token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"disposition","in":"query","schemaId":"schema_5660","description":"The response content disposition to set."},{"name":"token","in":"query","schemaId":"components/schemas/newStatus","description":"Access token used to gain temporary access to the document."},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the content instead of redirecting to the content."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/documents/{documentDescriptorId}/content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"disposition","in":"query","schemaId":"schema_5660"},{"name":"token","in":"query","schemaId":"components/schemas/newStatus"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"bearerAuthQuery","type":"apiKey","name":"token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/documents/{documentDescriptorId}/content","href":"documents/peach.docustore.handlers.download_person_document_content","openApiOperationId":"peach.docustore.handlers.download_person_document_content","summary":"Download document content","securityGroups":[{"oauth2":["document:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]},{"bearerAuthQuery":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The document content","mediaType":"application/pdf","mediaTypes":["application/pdf","text/html"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_5661"},"text/html":{"schemaId":"components/schemas/newStatus"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["application/pdf","text/html"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_5661"},"text/html":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.download_person_document_content"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/content"},{"label":"Upload document content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.upload_person_document_content","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.upload_person_document_content","metadata":{"seo":{"title":"Upload document content","description":"Upload document content"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.upload_person_document_content","name":"Upload document content","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload document content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5662"}},"schemaId":"schema_5662","pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/post/requestBody","description":"The document content"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/documents/{documentDescriptorId}/content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_5662"}},"responseCodes":["200","400"],"pointer":"/people/{personId}/documents/{documentDescriptorId}/content","href":"documents/peach.docustore.handlers.upload_person_document_content","openApiOperationId":"peach.docustore.handlers.upload_person_document_content","summary":"Upload document content","securityGroups":[{"oauth2":["document:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5662","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5662"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1content/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.upload_person_document_content"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/content"},{"label":"Convert document to the specified format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.convert_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.convert_person_document","metadata":{"seo":{"title":"Convert document to the specified format","description":"Convert document to the specified format"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.convert_person_document","name":"Convert document to the specified format","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1convert/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert document to the specified format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1convert/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_5663","description":"The document output format.","required":true},{"name":"sign","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Sign after conversion."},{"name":"deleteSource","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deletedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the source document to the current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time. This prevents it from appearing in future get documents requests."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1convert/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/documents/{documentDescriptorId}/convert","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"format","in":"query","required":true,"schemaId":"schema_5663"},{"name":"sign","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"deleteSource","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/people/{personId}/documents/{documentDescriptorId}/convert","href":"documents/peach.docustore.handlers.convert_person_document","openApiOperationId":"peach.docustore.handlers.convert_person_document","summary":"Convert document to the specified format","securityGroups":[{"oauth2":["document:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1convert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.convert_person_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/convert"},{"label":"Digitally sign document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.sign_person_pdf_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.sign_person_pdf_document","metadata":{"seo":{"title":"Digitally sign document","description":"Digitally sign document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.docustore.handlers.sign_person_pdf_document","name":"Digitally sign document","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1sign/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Digitally sign document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["document:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"documentDescriptorId","in":"path","schemaId":"schema_5625","description":"The document descriptor identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1sign/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/documents/{documentDescriptorId}/sign","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"documentDescriptorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["document:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/people/{personId}/documents/{documentDescriptorId}/sign","href":"documents/peach.docustore.handlers.sign_person_pdf_document","openApiOperationId":"peach.docustore.handlers.sign_person_pdf_document","summary":"Digitally sign document","securityGroups":[{"oauth2":["document:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}},"schemaId":"components/schemas/DocumentDescriptorResponse"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"},{"code":"500","description":"Server misconfiguration or error","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1people~1{personId}~1documents~1{documentDescriptorId}~1sign/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentDescriptorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentDescriptorResponse"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}},{"code":"500","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/peach.docustore.handlers.sign_person_pdf_document"}],"panels":[]}]},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/sign"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to add or create documents related to a borrower. There are multiple ways to use document object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a document from a Peach template. For example, loan terms or Autopay agreement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload any type of file. For example, a PDF copy of borrower's driver license."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents can also be used to render a legal disclosure from Peach template."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new document there are two steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a document descriptor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload document content/file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a new document is rendered from the template you just need to complete step #1."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/document-uploads/{documentUploadLinkKey}/documents","summary":"Create new document via link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.documents_via_links.create_document_via_link","deprecated":false},{"title":"/document-uploads/{documentUploadLinkKey}/documents/{documentDescriptorId}/content","summary":"Upload document content via link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","deprecated":false},{"title":"/people/{personId}/document-upload-links","summary":"Get document upload links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","deprecated":false},{"title":"/people/{personId}/document-upload-links","summary":"Create document upload link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","deprecated":false},{"title":"/people/{personId}/document-upload-links/{documentUploadLinkId}","summary":"Get doc upload link by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","deprecated":false},{"title":"/people/{personId}/documents","summary":"Get document descriptors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/peach.docustore.handlers.list_person_documents","deprecated":false},{"title":"/people/{personId}/documents","summary":"Create new document descriptor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.create_person_document","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}","summary":"Delete document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/documents/peach.docustore.handlers.delete_document","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}","summary":"Get document descriptor by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/peach.docustore.handlers.get_person_document","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}","summary":"Update document descriptor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/documents/peach.docustore.handlers.update_person_document","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}/content","summary":"Download document content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/peach.docustore.handlers.download_person_document_content","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}/content","summary":"Upload document content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.upload_person_document_content","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}/convert","summary":"Convert document to the specified format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.convert_person_document","deprecated":false},{"title":"/people/{personId}/documents/{documentDescriptorId}/sign","summary":"Digitally sign document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/peach.docustore.handlers.sign_person_pdf_document","deprecated":false}]}]}]}]}},{"type":"group","label":"Legal Representation","link":"/api-docs/api-public/legal-representation","routeSlug":"/api-docs/api-public/legal-representation","items":[{"label":"Get representatives","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_all","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_all","metadata":{"seo":{"title":"Get representatives","description":"Get representatives"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.legal.handlers.legal_representative_get_all","name":"Get representatives","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1legal-representatives/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get representatives","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["legal.representative:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived representatives into the result."}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/legal-representatives","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"includeArchived","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["legal.representative:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/legal-representatives","href":"legal-representation/peach.people.legal.handlers.legal_representative_get_all","openApiOperationId":"peach.people.legal.handlers.legal_representative_get_all","summary":"Get representatives","securityGroups":[{"oauth2":["legal.representative:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegalRepresentativesPaging"}},"schemaId":"components/schemas/LegalRepresentativesPaging"}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegalRepresentativesPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegalRepresentativesPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legal-representation/peach.people.legal.handlers.legal_representative_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/legal-representatives"},{"label":"Create representative","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_add","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_add","metadata":{"seo":{"title":"Create representative","description":"Create representative"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.legal.handlers.legal_representative_add","name":"Create representative","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1legal-representatives/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create representative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["legal.representative:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"schemaId":"components/schemas/LegalRepresentative","pointer":"/paths/~1people~1{personId}~1legal-representatives/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/legal-representatives","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["legal.representative:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"responseCodes":["200"],"pointer":"/people/{personId}/legal-representatives","href":"legal-representation/peach.people.legal.handlers.legal_representative_add","openApiOperationId":"peach.people.legal.handlers.legal_representative_add","summary":"Create representative","securityGroups":[{"oauth2":["legal.representative:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LegalRepresentative","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}},"schemaId":"schema_5664"}],"pointer":"/paths/~1people~1{personId}~1legal-representatives/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5664","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legal-representation/peach.people.legal.handlers.legal_representative_add"}],"panels":[]}]},"httpPath":"/people/{personId}/legal-representatives"},{"label":"Get representative by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","metadata":{"seo":{"title":"Get representative by ID","description":"Get representative by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.legal.handlers.legal_representative_get_by_id","name":"Get representative by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get representative by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["legal.representative:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"legalRepresentativeId","in":"path","schemaId":"schema_5625","description":"The legal representative object unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/legal-representatives/{legalRepresentativeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"legalRepresentativeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["legal.representative:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/legal-representatives/{legalRepresentativeId}","href":"legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","openApiOperationId":"peach.people.legal.handlers.legal_representative_get_by_id","summary":"Get representative by ID","securityGroups":[{"oauth2":["legal.representative:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}},"schemaId":"schema_5664"}],"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5664","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/legal-representatives/{legalRepresentativeId}"},{"label":"Update representative","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_update","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_update","metadata":{"seo":{"title":"Update representative","description":"Update representative"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.legal.handlers.legal_representative_update","name":"Update representative","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update representative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["legal.representative:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"legalRepresentativeId","in":"path","schemaId":"schema_5625","description":"The legal representative object unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"schemaId":"components/schemas/LegalRepresentative","pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/legal-representatives/{legalRepresentativeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"legalRepresentativeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["legal.representative:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"responseCodes":["200"],"pointer":"/people/{personId}/legal-representatives/{legalRepresentativeId}","href":"legal-representation/peach.people.legal.handlers.legal_representative_update","openApiOperationId":"peach.people.legal.handlers.legal_representative_update","summary":"Update representative","securityGroups":[{"oauth2":["legal.representative:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LegalRepresentative","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegalRepresentative"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}},"schemaId":"schema_5664"}],"pointer":"/paths/~1people~1{personId}~1legal-representatives~1{legalRepresentativeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5664","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5664"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legal-representation/peach.people.legal.handlers.legal_representative_update"}],"panels":[]}]},"httpPath":"/people/{personId}/legal-representatives/{legalRepresentativeId}"}],"content":{"contentType":"group","meta":{"name":"Legal Representation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Legal Representation","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a borrower is represented by a legal entity you can add the legal entity details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normally, if a borrower is represented by a status="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" legal entity we block"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future debt collection related communications."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/legal-representatives","summary":"Get representatives","prefix":{"name":"get","color":"get"},"badges":[],"link":"/legal-representation/peach.people.legal.handlers.legal_representative_get_all","deprecated":false},{"title":"/people/{personId}/legal-representatives","summary":"Create representative","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legal-representation/peach.people.legal.handlers.legal_representative_add","deprecated":false},{"title":"/people/{personId}/legal-representatives/{legalRepresentativeId}","summary":"Get representative by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","deprecated":false},{"title":"/people/{personId}/legal-representatives/{legalRepresentativeId}","summary":"Update representative","prefix":{"name":"put","color":"put"},"badges":[],"link":"/legal-representation/peach.people.legal.handlers.legal_representative_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications","link":"/api-docs/api-public/verifications","routeSlug":"/api-docs/api-public/verifications","items":[{"label":"Get verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","metadata":{"seo":{"title":"Get verifications","description":"Retrieve all verifications—optionally filtering. Note that unlike most Peach \"get all\" endpoints,the verifications get all endpoint returns items in a reverse chronological list, since almostall interesting verifications are those which happened in the recent past."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.borrower_verification.handlers.borrower_verification_get_all","name":"Get verifications","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1verifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all verifications—optionally filtering. Note that unlike most Peach \"get all\" endpoints,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the verifications get all endpoint returns items in a reverse chronological list, since almost"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all interesting verifications are those which happened in the recent past."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1verifications/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"status","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The comma separated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values of verifications to include in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not included, include all verifications."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1verifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/verifications","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","schemaId":"schema_5632","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/verifications","href":"verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","openApiOperationId":"peach.people.borrower_verification.handlers.borrower_verification_get_all","summary":"Get verifications","securityGroups":[{"oauth2":["verification:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationsPaging"}},"schemaId":"components/schemas/VerificationsPaging"}],"pointer":"/paths/~1people~1{personId}~1verifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/verifications"},{"label":"Start verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_create","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_create","metadata":{"seo":{"title":"Start verification","description":"Start a borrower verification session. Newly created verificationsinclude randomly selected questions about the borrower. The human must attemptto provide correct answers to these questions in order for the borrower verificationto be successful."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.borrower_verification.handlers.borrower_verification_create","name":"Start verification","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1verifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a borrower verification session. Newly created verifications"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include randomly selected questions about the borrower. The human must attempt"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to provide correct answers to these questions in order for the borrower verification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check if a verification can be started now without actually starting a verification,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"add the query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dryRun=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL. If a verification could be started now"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return successful ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), otherwise return an error response with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextVerificationOkAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating when the next verification can start."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then return successfully if the operation would complete successfully, but do not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actually save the changes which would result from this operation."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationPost"}},"schemaId":"components/schemas/VerificationPost","pointer":"/paths/~1people~1{personId}~1verifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/verifications","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"dryRun","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationPost"}},"responseCodes":["200","204","400","429"],"pointer":"/people/{personId}/verifications","href":"verifications/peach.people.borrower_verification.handlers.borrower_verification_create","openApiOperationId":"peach.people.borrower_verification.handlers.borrower_verification_create","summary":"Start verification","securityGroups":[{"oauth2":["verification:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/VerificationPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully started verification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5665"}},"schemaId":"schema_5665"},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A verification can be started now—only occurs with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dryRun=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]}]}]}]},{"code":"400","description":"A verification is not possible","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5666"}},"schemaId":"schema_5666"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A verification cannot be started now—try again later"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5667"}},"schemaId":"schema_5667"}],"pointer":"/paths/~1people~1{personId}~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5665","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5665"}}},{"code":"204"},{"code":"400","schemaId":"schema_5666","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5666"}}},{"code":"429","schemaId":"schema_5667","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5667"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_create"}],"panels":[]}]},"httpPath":"/people/{personId}/verifications"},{"label":"Get verification by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get","metadata":{"seo":{"title":"Get verification by ID","description":"Get verification by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.borrower_verification.handlers.borrower_verification_get","name":"Get verification by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"verificationId","in":"path","schemaId":"components/schemas/newStatus","description":"The borrower verification unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/verifications/{verificationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"verificationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/verifications/{verificationId}","href":"verifications/peach.people.borrower_verification.handlers.borrower_verification_get","openApiOperationId":"peach.people.borrower_verification.handlers.borrower_verification_get","summary":"Get verification by ID","securityGroups":[{"oauth2":["verification:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5665"}},"schemaId":"schema_5665"}],"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5665","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5665"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_get"}],"panels":[]}]},"httpPath":"/people/{personId}/verifications/{verificationId}"},{"label":"Answer verification questions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","metadata":{"seo":{"title":"Answer verification questions","description":"Answer verification questions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","name":"Answer verification questions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}~1attempts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Answer verification questions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"verificationId","in":"path","schemaId":"components/schemas/newStatus","description":"The borrower verification unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}~1attempts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationAttemptPost"}},"schemaId":"components/schemas/VerificationAttemptPost","pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}~1attempts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/verifications/{verificationId}/attempts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"verificationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationAttemptPost"}},"responseCodes":["200"],"pointer":"/people/{personId}/verifications/{verificationId}/attempts","href":"verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","openApiOperationId":"peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","summary":"Answer verification questions","securityGroups":[{"oauth2":["verification:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/VerificationAttemptPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationAttemptPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5668"}},"schemaId":"schema_5668"}],"pointer":"/paths/~1people~1{personId}~1verifications~1{verificationId}~1attempts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5668","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5668"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create"}],"panels":[]}]},"httpPath":"/people/{personId}/verifications/{verificationId}/attempts"}],"content":{"contentType":"group","meta":{"name":"Verifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications","showPageActions":true},{"nodeType":"markdoc","content":"A borrower verification session represents the\nquestion and response flow for an agent to verify the identity of a human\nwho purports to be a particular borrower. For instance, upon receiving a phone\ncall, an agent would initiate a borrower verification, ask the questions to the\nborrower, and enter their responses. A set of responses are either correct (thus\nverifying the human as the borrower) or they are incorrect.\n\nThe agent is never shown the correct answers, so privacy risks are\nminimized and socially engineered security attacks are mitigated."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/verifications","summary":"Get verifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","deprecated":false},{"title":"/people/{personId}/verifications","summary":"Start verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_create","deprecated":false},{"title":"/people/{personId}/verifications/{verificationId}","summary":"Get verification by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_get","deprecated":false},{"title":"/people/{personId}/verifications/{verificationId}/attempts","summary":"Answer verification questions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Verification Types","link":"/api-docs/api-public/verification-types","routeSlug":"/api-docs/api-public/verification-types","items":[{"label":"Get questions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","metadata":{"seo":{"title":"Get questions","description":"Retrieve all the questions which are available for use with verification types—i.e., the question bank."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.borrower_verification.handlers.borrower_verification_questions_get_all","name":"Get questions","isWebhook":false,"pointer":"/paths/~1verification-questions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get questions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all the questions which are available for use with verification types—i.e., the question bank."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification-questions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification-questions","href":"verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","openApiOperationId":"peach.borrower_verification.handlers.borrower_verification_questions_get_all","summary":"Get questions","securityGroups":[{"oauth2":["verification:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationQuestionsPaging"}},"schemaId":"components/schemas/VerificationQuestionsPaging"}],"pointer":"/paths/~1verification-questions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationQuestionsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationQuestionsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all"}],"panels":[]}]},"httpPath":"/verification-questions"},{"label":"Get verification types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","metadata":{"seo":{"title":"Get verification types","description":"Get verification types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.borrower_verification.handlers.borrower_verification_types_get_all","name":"Get verification types","isWebhook":false,"pointer":"/paths/~1verification-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification-type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1verification-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification-type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification-types","href":"verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","openApiOperationId":"peach.borrower_verification.handlers.borrower_verification_types_get_all","summary":"Get verification types","securityGroups":[{"oauth2":["verification-type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationTypesPaging"}},"schemaId":"components/schemas/VerificationTypesPaging"}],"pointer":"/paths/~1verification-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationTypesPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationTypesPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all"}],"panels":[]}]},"httpPath":"/verification-types"},{"label":"Create verification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","metadata":{"seo":{"title":"Create verification type","description":"Create a new borrower verification type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.borrower_verification.handlers.borrower_verification_types_create","name":"Create verification type","isWebhook":false,"pointer":"/paths/~1verification-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create verification type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new borrower verification type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This represents one configuration of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"how to perform borrower verifications. Later, when starting a new borrower verification,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can then specify a particular verification type to use. This done by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-ing to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/people/{personId}/verifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with a body like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"verificationTypeId\": \"VT-7RKX-OKQZ\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"verificationTypeId\": \"VT-7RKX-OKQZ\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"verification-types/peach.borrower_verification.handlers.borrower_verification_types_create/request/using-with-crm-app-ui","deepLinkHash":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create#verification-types/peach.borrower_verification.handlers.borrower_verification_types_create/request/using-with-crm-app-ui"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using with CRM App UI"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to specify that the CRM application should make use a particular"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification type you must set the company config value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.borrowerVerification.crmDefaultTypeId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the ID of the verification type ID of the verification type you wish to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.borrowerVerification.crmDefaultTypeId = \"VT-7RKX-OKQZ\""},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification-type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"schemaId":"components/schemas/VerificationType","pointer":"/paths/~1verification-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/verification-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification-type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"responseCodes":["200"],"pointer":"/verification-types","href":"verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","openApiOperationId":"peach.borrower_verification.handlers.borrower_verification_types_create","summary":"Create verification type","securityGroups":[{"oauth2":["verification-type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/VerificationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}},"schemaId":"schema_5669"}],"pointer":"/paths/~1verification-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5669","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create"}],"panels":[]}]},"httpPath":"/verification-types"},{"label":"Get verification type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","metadata":{"seo":{"title":"Get verification type by ID","description":"Get verification type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.borrower_verification.handlers.borrower_verification_types_get_one","name":"Get verification type by ID","isWebhook":false,"pointer":"/paths/~1verification-types~1{verificationTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification-type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"verificationTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique borrower verification type identifier.","required":true}],"pointer":"/paths/~1verification-types~1{verificationTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification-types/{verificationTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"verificationTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification-type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification-types/{verificationTypeId}","href":"verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","openApiOperationId":"peach.borrower_verification.handlers.borrower_verification_types_get_one","summary":"Get verification type by ID","securityGroups":[{"oauth2":["verification-type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}},"schemaId":"schema_5669"}],"pointer":"/paths/~1verification-types~1{verificationTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5669","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one"}],"panels":[]}]},"httpPath":"/verification-types/{verificationTypeId}"},{"label":"Update verification type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","metadata":{"seo":{"title":"Update verification type","description":"Update verification type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.borrower_verification.handlers.borrower_verification_types_update","name":"Update verification type","isWebhook":false,"pointer":"/paths/~1verification-types~1{verificationTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update verification type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["verification-type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"verificationTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique borrower verification type identifier.","required":true}],"pointer":"/paths/~1verification-types~1{verificationTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"schemaId":"components/schemas/VerificationType","pointer":"/paths/~1verification-types~1{verificationTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/verification-types/{verificationTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"verificationTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["verification-type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"responseCodes":["200"],"pointer":"/verification-types/{verificationTypeId}","href":"verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","openApiOperationId":"peach.borrower_verification.handlers.borrower_verification_types_update","summary":"Update verification type","securityGroups":[{"oauth2":["verification-type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/VerificationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}},"schemaId":"schema_5669"}],"pointer":"/paths/~1verification-types~1{verificationTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5669","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5669"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update"}],"panels":[]}]},"httpPath":"/verification-types/{verificationTypeId}"}],"content":{"contentType":"group","meta":{"name":"Verification Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification Types","showPageActions":true},{"nodeType":"markdoc","content":"This object represents configurations describing how new borrower verifications\nshould behave."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/verification-questions","summary":"Get questions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","deprecated":false},{"title":"/verification-types","summary":"Get verification types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","deprecated":false},{"title":"/verification-types","summary":"Create verification type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","deprecated":false},{"title":"/verification-types/{verificationTypeId}","summary":"Get verification type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","deprecated":false},{"title":"/verification-types/{verificationTypeId}","summary":"Update verification type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Campaign Management","content":null},{"type":"group","label":"Campaign Overview","link":"/api-docs/api-public/campaign-overview","routeSlug":"/api-docs/api-public/campaign-overview","items":[],"content":{"contentType":"group","meta":{"name":"Campaign Overview"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Overview","showPageActions":true},{"nodeType":"markdoc","content":"The campaign feature allows lenders to create a list of borrower contacts that meet certain criteria,\nfor consumption by auto-dialer systems. For example, if the \"Auto-create collection cases\" procedure is\nconfigured along with the auto-close feature you can create a query that looks at the open collection\ncases to understand what borrowers you consider to still be delinquent after starting collections on\nthem. You can then layer on which cases have been snoozed and/or do not have scheduled calls.\nThe campaign feature has two basic components. The Campaign, is a query that collects a list of borrowers\nto contact that can be triggered at predefined intervals. The Contact Exporter defines how and where the\ncontacts are delivered. Multiple Campaigns can use a single Exporter. The lender can create and maintain\na list of Campaigns and Contact Exporters as needed."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-overview"}],"panels":[]}]}},{"type":"group","label":"Campaigns","link":"/api-docs/api-public/campaigns","routeSlug":"/api-docs/api-public/campaigns","items":[{"label":"Get campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get_all","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get_all","metadata":{"seo":{"title":"Get campaigns","description":"Get a list of all campaigns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers.campaign_get_all","name":"Get campaigns","isWebhook":false,"pointer":"/paths/~1campaigns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaigns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of all campaigns.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."}],"pointer":"/paths/~1campaigns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaigns","href":"campaigns/peach.people.campaigns.handlers.campaign_get_all","openApiOperationId":"peach.people.campaigns.handlers.campaign_get_all","summary":"Get campaigns","securityGroups":[{"oauth2":["borrowercampaign:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}},"schemaId":"schema_5670"}],"pointer":"/paths/~1campaigns/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5670","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers.campaign_get_all"}],"panels":[]}]},"httpPath":"/campaigns"},{"label":"Create campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_create","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_create","metadata":{"seo":{"title":"Create campaign","description":"Create a new campaign by associating a Redash query that returns a single column containing borrower IDs labeled \"id\". The campaign can also be scheduled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers.campaign_create","name":"Create campaign","isWebhook":false,"pointer":"/paths/~1campaigns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new campaign by associating a Redash query that returns a single column containing\nborrower IDs labeled \"id\". The campaign can also be scheduled.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"schemaId":"components/schemas/BorrowerCampaign","pointer":"/paths/~1campaigns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"responseCodes":["200"],"pointer":"/campaigns","href":"campaigns/peach.people.campaigns.handlers.campaign_create","openApiOperationId":"peach.people.campaigns.handlers.campaign_create","summary":"Create campaign","securityGroups":[{"oauth2":["borrowercampaign:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BorrowerCampaign","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}},"schemaId":"schema_5671"}],"pointer":"/paths/~1campaigns/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers.campaign_create"}],"panels":[]}]},"httpPath":"/campaigns"},{"label":"Get campaign by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get","metadata":{"seo":{"title":"Get campaign by ID","description":"Get a campaign by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers.campaign_get","name":"Get campaign by ID","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a campaign by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns/{borrowerCampaignId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}","href":"campaigns/peach.people.campaigns.handlers.campaign_get","openApiOperationId":"peach.people.campaigns.handlers.campaign_get","summary":"Get campaign by ID","securityGroups":[{"oauth2":["borrowercampaign:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}},"schemaId":"schema_5671"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers.campaign_get"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}"},{"label":"Update campaign","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_update","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_update","metadata":{"seo":{"title":"Update campaign","description":"Update a campaign by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers.campaign_update","name":"Update campaign","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a campaign by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"schemaId":"components/schemas/BorrowerCampaign","pointer":"/paths/~1campaigns~1{borrowerCampaignId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaigns/{borrowerCampaignId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}","href":"campaigns/peach.people.campaigns.handlers.campaign_update","openApiOperationId":"peach.people.campaigns.handlers.campaign_update","summary":"Update campaign","securityGroups":[{"oauth2":["borrowercampaign:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BorrowerCampaign","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaign"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}},"schemaId":"schema_5671"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers.campaign_update"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}"},{"label":"Get campaign runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","metadata":{"seo":{"title":"Get campaign runs","description":"Get a list of campaign runs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.campaign_run_list","name":"Get campaign runs","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of campaign runs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns/{borrowerCampaignId}/runs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}/runs","href":"campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","openApiOperationId":"peach.people.campaigns.handlers_runs.campaign_run_list","summary":"Get campaign runs","securityGroups":[{"oauth2":["borrowercampaign.run:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}},"schemaId":"schema_5670"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5670","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}/runs"},{"label":"Run campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","metadata":{"seo":{"title":"Run campaign","description":"Start a new borrower campaign run and save results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.campaign_run_create","name":"Run campaign","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a new borrower campaign run and save results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the campaign run is controlled by configured settings on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the campaign object and via the associated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BulkSender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContextExporter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default when the campaign runs, it executes the Redash query referenced in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redashQueryUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and feeds the query results as input to the campaign run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally, you can override this by specifing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryResultsOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as input."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5672"}},"schemaId":"schema_5672","pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns/{borrowerCampaignId}/runs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5672"}},"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}/runs","href":"campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","openApiOperationId":"peach.people.campaigns.handlers_runs.campaign_run_create","summary":"Run campaign","securityGroups":[{"oauth2":["borrowercampaign.run:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5672","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5672"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"schemaId":"components/schemas/BorrowerCampaignRun"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BorrowerCampaignRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}/runs"},{"label":"Get campaign run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","metadata":{"seo":{"title":"Get campaign run","description":"Get campaign run data by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.campaign_run_read","name":"Get campaign run","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get campaign run data by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true},{"name":"borrowerCampaignRunId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"borrowerCampaignRunId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","href":"campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","openApiOperationId":"peach.people.campaigns.handlers_runs.campaign_run_read","summary":"Get campaign run","securityGroups":[{"oauth2":["borrowercampaign.run:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"schemaId":"components/schemas/BorrowerCampaignRun"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BorrowerCampaignRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}"},{"label":"Update campaign run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","metadata":{"seo":{"title":"Update campaign run","description":"Update campaign run data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.campaign_run_update","name":"Update campaign run","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update campaign run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update campaign run data.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true},{"name":"borrowerCampaignRunId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"schemaId":"components/schemas/BorrowerCampaignRun","pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"borrowerCampaignRunId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","href":"campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","openApiOperationId":"peach.people.campaigns.handlers_runs.campaign_run_update","summary":"Update campaign run","securityGroups":[{"oauth2":["borrowercampaign.run:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BorrowerCampaignRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}},"schemaId":"components/schemas/BorrowerCampaignRun"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BorrowerCampaignRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BorrowerCampaignRun"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}"},{"label":"Download all files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","metadata":{"seo":{"title":"Download all files","description":"Download files generated by a campaign run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.campaign_run_download","name":"Download all files","isWebhook":false,"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download all files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download files generated by a campaign run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true},{"name":"borrowerCampaignRunId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"file","in":"query","schemaId":"schema_5673","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify which file should be downloaded from this campaign run. The requested files will be returned as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"query_results.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A CSV formatted file of the query results received from Redash"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_input.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A JSON formatted file of the parsed query results used as input to the campaign"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contacts.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The exported contacts as CSV—i.e., the output."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log.txt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A log of the campaign run process."},"children":[]}]}]}]}]}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}/download","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"borrowerCampaignRunId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"file","in":"query","schemaId":"schema_5673"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}/download","href":"campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","openApiOperationId":"peach.people.campaigns.handlers_runs.campaign_run_download","summary":"Download all files","securityGroups":[{"oauth2":["borrowercampaign.run:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1campaigns~1{borrowerCampaignId}~1runs~1{borrowerCampaignRunId}~1download/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download"}],"panels":[]}]},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}/download"},{"label":"Get campaign runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","metadata":{"seo":{"title":"Get campaign runs","description":"Get a list of campaign runs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_runs.internal_campaign_run_list","name":"Get campaign runs","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1campaigns~1{borrowerCampaignId}~1runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of campaign runs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["borrowercampaign.run:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"borrowerCampaignId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1companies~1{companyId}~1campaigns~1{borrowerCampaignId}~1runs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1campaigns~1{borrowerCampaignId}~1runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/campaigns/{borrowerCampaignId}/runs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"borrowerCampaignId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["borrowercampaign.run:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/campaigns/{borrowerCampaignId}/runs","href":"campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","openApiOperationId":"peach.people.campaigns.handlers_runs.internal_campaign_run_list","summary":"Get campaign runs","securityGroups":[{"oauth2":["borrowercampaign.run:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}},"schemaId":"schema_5670"}],"pointer":"/paths/~1companies~1{companyId}~1campaigns~1{borrowerCampaignId}~1runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5670","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5670"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/campaigns/{borrowerCampaignId}/runs"}],"content":{"contentType":"group","meta":{"name":"Campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","showPageActions":true},{"nodeType":"markdoc","content":"This object allows you to create custom Campaigns. A Campaign is characterized by a set of rules, defined\nas a SQL query created in Redash and associated with the Campaign. A Campaign can be triggered at predefined\nintervals. For example, a Campaign can be triggered every day to add borrowers who are 30 days past due. Campaigns\ncan also be manually triggered.\nWhen a Campaign is triggered by schedule or manually, a query is executed against the lender's replica data and\nreturns a list of person IDs. The output is sent to the configured Contact Exporter to be written as a configurable\nCSV file with contact information required by auto dialers and other systems."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaigns","summary":"Get campaigns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers.campaign_get_all","deprecated":false},{"title":"/campaigns","summary":"Create campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers.campaign_create","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}","summary":"Get campaign by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers.campaign_get","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}","summary":"Update campaign","prefix":{"name":"put","color":"put"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers.campaign_update","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}/runs","summary":"Get campaign runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}/runs","summary":"Run campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","summary":"Get campaign run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","summary":"Update campaign run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","deprecated":false},{"title":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}/download","summary":"Download all files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","deprecated":false},{"title":"/companies/{companyId}/campaigns/{borrowerCampaignId}/runs","summary":"Get campaign runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Exporters","link":"/api-docs/api-public/contact-exporters","routeSlug":"/api-docs/api-public/contact-exporters","items":[{"label":"List contact exporters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","metadata":{"seo":{"title":"List contact exporters","description":"Get a list of all contact exporters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact_exporters.handlers.contact_exporter_list","name":"List contact exporters","isWebhook":false,"pointer":"/paths/~1campaign-workers~1contact-exporters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contact exporters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of all contact exporters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contactexporter:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."}],"pointer":"/paths/~1campaign-workers~1contact-exporters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign-workers/contact-exporters","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contactexporter:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/contact-exporters","href":"contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","openApiOperationId":"peach.people.contact_exporters.handlers.contact_exporter_list","summary":"List contact exporters","securityGroups":[{"oauth2":["contactexporter:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5674"}},"schemaId":"schema_5674"}],"pointer":"/paths/~1campaign-workers~1contact-exporters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5674","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5674"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list"}],"panels":[]}]},"httpPath":"/campaign-workers/contact-exporters"},{"label":"Create contact exporter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","metadata":{"seo":{"title":"Create contact exporter","description":"Create a new Contact Exporter by defining the contact matching criteria and the exportable columns. Ifdesired, designate an SFTP setting and/or screen through Compliance Guard."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact_exporters.handlers.contact_exporter_create","name":"Create contact exporter","isWebhook":false,"pointer":"/paths/~1campaign-workers~1contact-exporters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create contact exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Contact Exporter by defining the contact matching criteria and the exportable columns. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desired, designate an SFTP setting and/or screen through Compliance Guard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When contacts are screened, the exporter calls Compliance Guard with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkAtCompanyNoon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkAtCompanyNoon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can Interact Endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"further information. In other words, regardless of the time of day that the exporter runs, compliance is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checked as of noon in the company's time zone. This does not override other reasons a check can fail:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the borrower having a Do Not Interact in place, having reached the interaction frequency limit, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where possible, it's always advised to check compliance right before an action. Many things can change"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(payments are made, other automated interactions are sent, consents/addresses can be updated)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from when you plan something to happen to when it actually happens. Lenders are responsible for ensuring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is still permissible to conduct the interaction."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contactexporter:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"schemaId":"components/schemas/ContactExporter","pointer":"/paths/~1campaign-workers~1contact-exporters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaign-workers/contact-exporters","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contactexporter:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"responseCodes":["200"],"pointer":"/campaign-workers/contact-exporters","href":"contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","openApiOperationId":"peach.people.contact_exporters.handlers.contact_exporter_create","summary":"Create contact exporter","securityGroups":[{"oauth2":["contactexporter:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/ContactExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}},"schemaId":"schema_5675"}],"pointer":"/paths/~1campaign-workers~1contact-exporters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create"}],"panels":[]}]},"httpPath":"/campaign-workers/contact-exporters"},{"label":"Delete contact exporter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","metadata":{"seo":{"title":"Delete contact exporter","description":"Delete a contact exporter by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact_exporters.handlers.contact_exporter_delete","name":"Delete contact exporter","isWebhook":false,"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete contact exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a contact exporter by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contactexporter:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactExporterId","in":"path","schemaId":"schema_5625","description":"The contactExporter object unique identifier.","required":true}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/campaign-workers/contact-exporters/{contactExporterId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"contactExporterId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contactexporter:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/contact-exporters/{contactExporterId}","href":"contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","openApiOperationId":"peach.people.contact_exporters.handlers.contact_exporter_delete","summary":"Delete contact exporter","securityGroups":[{"oauth2":["contactexporter:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete"}],"panels":[]}]},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}"},{"label":"Get contact exporter by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","metadata":{"seo":{"title":"Get contact exporter by ID","description":"Get a contact exporter by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact_exporters.handlers.contact_exporter_get_by_id","name":"Get contact exporter by ID","isWebhook":false,"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contact exporter by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a contact exporter by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contactexporter:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactExporterId","in":"path","schemaId":"schema_5625","description":"The contactExporter object unique identifier.","required":true}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign-workers/contact-exporters/{contactExporterId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"contactExporterId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contactexporter:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/contact-exporters/{contactExporterId}","href":"contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","openApiOperationId":"peach.people.contact_exporters.handlers.contact_exporter_get_by_id","summary":"Get contact exporter by ID","securityGroups":[{"oauth2":["contactexporter:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}},"schemaId":"schema_5675"}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id"}],"panels":[]}]},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}"},{"label":"Update contact exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","metadata":{"seo":{"title":"Update contact exporter","description":"Update a contact exporter by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.contact_exporters.handlers.contact_exporter_update","name":"Update contact exporter","isWebhook":false,"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update contact exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a contact exporter by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["contactexporter:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactExporterId","in":"path","schemaId":"schema_5625","description":"The contactExporter object unique identifier.","required":true}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"schemaId":"components/schemas/ContactExporter","pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaign-workers/contact-exporters/{contactExporterId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"contactExporterId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["contactexporter:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"responseCodes":["200"],"pointer":"/campaign-workers/contact-exporters/{contactExporterId}","href":"contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","openApiOperationId":"peach.people.contact_exporters.handlers.contact_exporter_update","summary":"Update contact exporter","securityGroups":[{"oauth2":["contactexporter:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/ContactExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}},"schemaId":"schema_5675"}],"pointer":"/paths/~1campaign-workers~1contact-exporters~1{contactExporterId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5675"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update"}],"panels":[]}]},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}"}],"content":{"contentType":"group","meta":{"name":"Contact Exporters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Exporters","showPageActions":true},{"nodeType":"markdoc","content":"This object allows you to create custom Contact Exporters. The Contact Exporter defines how and where the\ncontacts generated by the Campaign are delivered."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaign-workers/contact-exporters","summary":"List contact exporters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","deprecated":false},{"title":"/campaign-workers/contact-exporters","summary":"Create contact exporter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","deprecated":false},{"title":"/campaign-workers/contact-exporters/{contactExporterId}","summary":"Delete contact exporter","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","deprecated":false},{"title":"/campaign-workers/contact-exporters/{contactExporterId}","summary":"Get contact exporter by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","deprecated":false},{"title":"/campaign-workers/contact-exporters/{contactExporterId}","summary":"Update contact exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Senders","link":"/api-docs/api-public/bulk-senders","routeSlug":"/api-docs/api-public/bulk-senders","items":[{"label":"List bulk senders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","metadata":{"seo":{"title":"List bulk senders","description":"Get a list of all bulk senders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_workers.bulk_sender_list","name":"List bulk senders","isWebhook":false,"pointer":"/paths/~1campaign-workers~1bulk-senders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk senders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of all bulk senders.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bulksender:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."}],"pointer":"/paths/~1campaign-workers~1bulk-senders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign-workers/bulk-senders","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bulksender:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/bulk-senders","href":"bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","openApiOperationId":"peach.people.campaigns.handlers_workers.bulk_sender_list","summary":"List bulk senders","securityGroups":[{"oauth2":["bulksender:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5676"}},"schemaId":"schema_5676"}],"pointer":"/paths/~1campaign-workers~1bulk-senders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5676","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5676"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list"}],"panels":[]}]},"httpPath":"/campaign-workers/bulk-senders"},{"label":"Create bulk sender","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","metadata":{"seo":{"title":"Create bulk sender","description":"Create a new bulk sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_workers.bulk_sender_create","name":"Create bulk sender","isWebhook":false,"pointer":"/paths/~1campaign-workers~1bulk-senders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bulk sender","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new bulk sender.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bulksender:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSenderCreate"}},"schemaId":"components/schemas/BulkSenderCreate","pointer":"/paths/~1campaign-workers~1bulk-senders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaign-workers/bulk-senders","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bulksender:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkSenderCreate"}},"responseCodes":["201"],"pointer":"/campaign-workers/bulk-senders","href":"bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","openApiOperationId":"peach.people.campaigns.handlers_workers.bulk_sender_create","summary":"Create bulk sender","securityGroups":[{"oauth2":["bulksender:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BulkSenderCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSenderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}},"schemaId":"schema_5677"}],"pointer":"/paths/~1campaign-workers~1bulk-senders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5677","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create"}],"panels":[]}]},"httpPath":"/campaign-workers/bulk-senders"},{"label":"Delete bulk sender","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","metadata":{"seo":{"title":"Delete bulk sender","description":"Delete a bulk sender by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_workers.bulk_sender_delete","name":"Delete bulk sender","isWebhook":false,"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete bulk sender","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a bulk sender by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bulksender:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulkSenderId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/campaign-workers/bulk-senders/{bulkSenderId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"bulkSenderId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bulksender:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/bulk-senders/{bulkSenderId}","href":"bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","openApiOperationId":"peach.people.campaigns.handlers_workers.bulk_sender_delete","summary":"Delete bulk sender","securityGroups":[{"oauth2":["bulksender:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete"}],"panels":[]}]},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}"},{"label":"Get bulk sender by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","metadata":{"seo":{"title":"Get bulk sender by ID","description":"Get a bulk sender by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_workers.bulk_sender_get","name":"Get bulk sender by ID","isWebhook":false,"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk sender by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a bulk sender by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bulksender:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulkSenderId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign-workers/bulk-senders/{bulkSenderId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"bulkSenderId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bulksender:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/campaign-workers/bulk-senders/{bulkSenderId}","href":"bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","openApiOperationId":"peach.people.campaigns.handlers_workers.bulk_sender_get","summary":"Get bulk sender by ID","securityGroups":[{"oauth2":["bulksender:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}},"schemaId":"schema_5677"}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5677","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get"}],"panels":[]}]},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}"},{"label":"Update bulk sender","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","metadata":{"seo":{"title":"Update bulk sender","description":"Update the existing bulk sender"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.campaigns.handlers_workers.bulk_sender_update","name":"Update bulk sender","isWebhook":false,"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk sender","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the existing bulk sender\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bulksender:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulkSenderId","in":"path","schemaId":"schema_5625","required":true}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSender"}},"schemaId":"components/schemas/BulkSender","pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaign-workers/bulk-senders/{bulkSenderId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"bulkSenderId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bulksender:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkSender"}},"responseCodes":["200"],"pointer":"/campaign-workers/bulk-senders/{bulkSenderId}","href":"bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","openApiOperationId":"peach.people.campaigns.handlers_workers.bulk_sender_update","summary":"Update bulk sender","securityGroups":[{"oauth2":["bulksender:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BulkSender","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSender"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}},"schemaId":"schema_5677"}],"pointer":"/paths/~1campaign-workers~1bulk-senders~1{bulkSenderId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5677","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5677"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update"}],"panels":[]}]},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}"}],"content":{"contentType":"group","meta":{"name":"Bulk Senders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Senders","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A bulk sender object represents a campaign worker which sends messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the borrowers returned by a campaign's query results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each row returned by the campaign in its query result a message is sent via the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some of the query results columns are automatically mapped to the request body of the Send endpoint,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"these columns are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interactionExternalId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isTransactional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousInteractionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useTemplate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order for a bulk sender to function, at a minimum the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"campaign's query results must return at least the column"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that bulk senders send with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ strictUndefined: true }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so any missing context variables"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will cause the send request to fail rather than sending with a default (empty) value, which is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the standard behavior for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communicator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details on required columns see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InteractionSubject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation for "},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign run"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaign-workers/bulk-senders","summary":"List bulk senders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","deprecated":false},{"title":"/campaign-workers/bulk-senders","summary":"Create bulk sender","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","deprecated":false},{"title":"/campaign-workers/bulk-senders/{bulkSenderId}","summary":"Delete bulk sender","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","deprecated":false},{"title":"/campaign-workers/bulk-senders/{bulkSenderId}","summary":"Get bulk sender by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","deprecated":false},{"title":"/campaign-workers/bulk-senders/{bulkSenderId}","summary":"Update bulk sender","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Case Management","content":null},{"type":"group","label":"Cases","link":"/api-docs/api-public/cases","routeSlug":"/api-docs/api-public/cases","items":[{"label":"List active case escalations for a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","metadata":{"seo":{"title":"List active case escalations for a company","description":"List active case escalations for a company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.escalations.handlers.case_open_escalations_get_by_company","name":"List active case escalations for a company","isWebhook":false,"pointer":"/paths/~1active-escalations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List active case escalations for a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List active case escalations for a company\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."}],"pointer":"/paths/~1active-escalations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/active-escalations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/active-escalations","href":"cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","openApiOperationId":"peach.cases.escalations.handlers.case_open_escalations_get_by_company","summary":"List active case escalations for a company","securityGroups":[{"oauth2":["case:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5678"}},"schemaId":"schema_5678"}],"pointer":"/paths/~1active-escalations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5678","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5678"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company"}],"panels":[]}]},"httpPath":"/active-escalations"},{"label":"Get all cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_company","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_company","metadata":{"seo":{"title":"Get all cases","description":"Get all cases. Returns only borrower-bound cases by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.list_cases_by_company","name":"Get all cases","isWebhook":false,"pointer":"/paths/~1cases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all cases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all cases. Returns only borrower-bound cases by default.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1cases/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"expand","in":"query","schemaId":"schema_5623","description":"Replace component IDs with corresponding objects"},{"name":"include","in":"query","schemaId":"schema_5679","description":"A comma separated list of field names to include in the response.\n"},{"name":"associations","in":"query","schemaId":"schema_5680","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of related object to return with the case data."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no references to related objects are inserted into the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", insert an array of all relations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise insert array of single type."},"children":[]}]}]}]}]},{"name":"outcome","in":"query","schemaId":"schema_5681"},{"name":"status","in":"query","schemaId":"schema_5682"},{"name":"statuses","in":"query","schemaId":"schema_5683"},{"name":"statusUpdatedBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusUpdatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time from before the given value"},"children":[]}]}]}]},{"name":"statusUpdatedAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusUpdatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time after the given value"},"children":[]}]}]}]},{"name":"caseNumber","in":"query","schemaId":"components/schemas/newStatus","description":"Filter cases by external case number"},{"name":"caseType","in":"query","schemaId":"schema_5684","description":"The name of the case type.\n"},{"name":"createdBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time before the given value"},"children":[]}]}]}]},{"name":"createdAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time after the given value"},"children":[]}]}]}]},{"name":"nupUpdatedNull","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Filters to cases that have been sent in the NUP file if true, otherwise filters them out if false.\n(Only applies to Bankruptcy cases)\n"},{"name":"snoozedUntilBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter only cases with a snooze (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozeUntil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value) set to expire before the specified datetime. Note that a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snoozed case is set to None automatically very shortly after it expires."},"children":[]}]}]}]},{"name":"snoozedUntilAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter only cases with a snooze (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozeUntil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value) set to expire after the specified datetime."},"children":[]}]}]}]},{"name":"owningEmployeeId","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owningEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to the given employee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID. If the employee ID is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", filter by cases which have no owning employee."},"children":[]}]}]}]},{"name":"loanTypes","in":"query","schemaId":"schema_5685","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a list of loan types. Only includes cases with loans of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified loan types. Special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means to include cases with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no associated loans."},"children":[]}]}]}]},{"name":"interaction.status","in":"query","schemaId":"schema_5686","description":"Filter cases which have an associated interaction with the specified status.\n"},{"name":"interaction.channel","in":"query","schemaId":"schema_5687","description":"Filter cases which have an associated interaction with the specified channel.\n"},{"name":"interaction.scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled start date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before the specified value. (i.e., the specified value is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled start date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the specified value. (i.e., the specified value is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled end date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before the specified value. (i.e., the specified value is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled end date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the specified value. (i.e., the specified value is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"associatedDocumentId","in":"query","schemaId":"components/schemas/newStatus","description":"Filter by an associated document ID, public or external. Only includes\ncases that have been associated with the given document ID.\n"}],"pointer":"/paths/~1cases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"expand","in":"query","schemaId":"schema_5623"},{"name":"include","in":"query","schemaId":"schema_5679"},{"name":"associations","in":"query","required":false,"schemaId":"schema_5680"},{"name":"outcome","in":"query","required":false,"schemaId":"schema_5681"},{"name":"status","in":"query","required":false,"schemaId":"schema_5682"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5683"},{"name":"statusUpdatedBefore","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"statusUpdatedAfter","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"caseNumber","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"caseType","in":"query","schemaId":"schema_5684"},{"name":"createdBefore","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAfter","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"nupUpdatedNull","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"snoozedUntilBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"snoozedUntilAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"owningEmployeeId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"loanTypes","in":"query","schemaId":"schema_5685"},{"name":"interaction.status","in":"query","schemaId":"schema_5686"},{"name":"interaction.channel","in":"query","schemaId":"schema_5687"},{"name":"interaction.scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"associatedDocumentId","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cases","href":"cases/peach.cases.handlers.list_cases_by_company","openApiOperationId":"peach.cases.handlers.list_cases_by_company","summary":"Get all cases","securityGroups":[{"oauth2":["case:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}},"schemaId":"schema_5688"}],"pointer":"/paths/~1cases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.list_cases_by_company"}],"panels":[]}]},"httpPath":"/cases"},{"label":"Get borrower cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_borrower","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_borrower","metadata":{"seo":{"title":"Get borrower cases","description":"Get all cases associated with a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.list_cases_by_borrower","name":"Get borrower cases","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrower cases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all cases associated with a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"expand","in":"query","schemaId":"schema_5623","description":"Replace component IDs with corresponding objects"},{"name":"include","in":"query","schemaId":"schema_5679","description":"A comma separated list of field names to include in the response.\n"},{"name":"associations","in":"query","schemaId":"schema_5680","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of related object to return with the case data."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no references to related objects are inserted into the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", insert an array of all relations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise insert array of single type."},"children":[]}]}]}]}]},{"name":"outcome","in":"query","schemaId":"schema_5681"},{"name":"status","in":"query","schemaId":"schema_5682"},{"name":"statuses","in":"query","schemaId":"schema_5683"},{"name":"statusUpdatedBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusUpdatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time from before the given value"},"children":[]}]}]}]},{"name":"statusUpdatedAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusUpdatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time after the given value"},"children":[]}]}]}]},{"name":"caseNumber","in":"query","schemaId":"components/schemas/newStatus","description":"Filter cases by external case number"},{"name":"caseType","in":"query","schemaId":"schema_5684","description":"The name of the case type.\n"},{"name":"createdBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time before the given value"},"children":[]}]}]}]},{"name":"createdAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time after the given value"},"children":[]}]}]}]},{"name":"nupUpdatedNull","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Filters to cases that have been sent in the NUP file if true, otherwise filters them out if false.\n(Only applies to Bankruptcy cases)\n"},{"name":"snoozedUntilBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter only cases with a snooze (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozeUntil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value) set to expire before the specified datetime. Note that a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snoozed case is set to None automatically very shortly after it expires."},"children":[]}]}]}]},{"name":"snoozedUntilAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter only cases with a snooze (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozeUntil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value) set to expire after the specified datetime."},"children":[]}]}]}]},{"name":"owningEmployeeId","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by cases which have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owningEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to the given employee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID. If the employee ID is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", filter by cases which have no owning employee."},"children":[]}]}]}]},{"name":"loanTypes","in":"query","schemaId":"schema_5685","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a list of loan types. Only includes cases with loans of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified loan types. Special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means to include cases with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no associated loans."},"children":[]}]}]}]},{"name":"interaction.status","in":"query","schemaId":"schema_5686","description":"Filter cases which have an associated interaction with the specified status.\n"},{"name":"interaction.channel","in":"query","schemaId":"schema_5687","description":"Filter cases which have an associated interaction with the specified channel.\n"},{"name":"interaction.scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled start date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before the specified value. (i.e., the specified value is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled start date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the specified value. (i.e., the specified value is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled end date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before the specified value. (i.e., the specified value is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"interaction.scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cases which have an associated interaction with a scheduled end date-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the specified value. (i.e., the specified value is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]},{"name":"associatedDocumentId","in":"query","schemaId":"components/schemas/newStatus","description":"Filter by an associated document ID, public or external. Only includes\ncases that have been associated with the given document ID.\n"}],"pointer":"/paths/~1people~1{personId}~1cases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"expand","in":"query","schemaId":"schema_5623"},{"name":"include","in":"query","schemaId":"schema_5679"},{"name":"associations","in":"query","required":false,"schemaId":"schema_5680"},{"name":"outcome","in":"query","required":false,"schemaId":"schema_5681"},{"name":"status","in":"query","required":false,"schemaId":"schema_5682"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5683"},{"name":"statusUpdatedBefore","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"statusUpdatedAfter","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"caseNumber","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"caseType","in":"query","schemaId":"schema_5684"},{"name":"createdBefore","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAfter","in":"query","required":false,"schemaId":"components/schemas/transactionCreatedAt"},{"name":"nupUpdatedNull","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"snoozedUntilBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"snoozedUntilAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"owningEmployeeId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"loanTypes","in":"query","schemaId":"schema_5685"},{"name":"interaction.status","in":"query","schemaId":"schema_5686"},{"name":"interaction.channel","in":"query","schemaId":"schema_5687"},{"name":"interaction.scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"interaction.scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"associatedDocumentId","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases","href":"cases/peach.cases.handlers.list_cases_by_borrower","openApiOperationId":"peach.cases.handlers.list_cases_by_borrower","summary":"Get borrower cases","securityGroups":[{"oauth2":["case:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}},"schemaId":"schema_5688"}],"pointer":"/paths/~1people~1{personId}~1cases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.list_cases_by_borrower"}],"panels":[]}]},"httpPath":"/people/{personId}/cases"},{"label":"Create borrower case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.create_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.create_case","metadata":{"seo":{"title":"Create borrower case","description":"Create a new case and associate it with a borrower using their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.create_case","name":"Create borrower case","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create borrower case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new case and associate it with a borrower using their ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Case"}},"schemaId":"components/schemas/Case","pointer":"/paths/~1people~1{personId}~1cases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Case"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases","href":"cases/peach.cases.handlers.create_case","openApiOperationId":"peach.cases.handlers.create_case","summary":"Create borrower case","securityGroups":[{"oauth2":["case:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Case","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Case"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}},"schemaId":"schema_5689"}],"pointer":"/paths/~1people~1{personId}~1cases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.create_case"}],"panels":[]}]},"httpPath":"/people/{personId}/cases"},{"label":"Remove association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.remove_case_association","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.remove_case_association","metadata":{"seo":{"title":"Remove association","description":"Remove association of an existing case, interaction, loan, or file objects from the case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.remove_case_association","name":"Remove association","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove association of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects from the case."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.association:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"objectType","in":"query","schemaId":"schema_5690","description":"Type of object to remove from the case.\n","required":true},{"name":"objectId","in":"query","schemaId":"components/schemas/newStatus","description":"Peach unique identifier for the associated object to remove from the case.","required":true,"example":"LN-AAAA-BBBB"},{"name":"relation","in":"query","schemaId":"schema_5691","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Label for a relationship between entities. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"causes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are assumed to be directional, while the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"related"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-directional,"},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/cases/{caseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"objectType","in":"query","required":true,"schemaId":"schema_5690"},{"name":"objectId","in":"query","required":true,"example":"LN-AAAA-BBBB","schemaId":"components/schemas/newStatus"},{"name":"relation","in":"query","required":false,"schemaId":"schema_5691"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.association:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}","href":"cases/peach.cases.handlers.remove_case_association","openApiOperationId":"peach.cases.handlers.remove_case_association","summary":"Remove association","securityGroups":[{"oauth2":["case.association:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.remove_case_association"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}"},{"label":"Get borrower case by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.get_case_by_id","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.get_case_by_id","metadata":{"seo":{"title":"Get borrower case by ID","description":"Get borrower case by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.get_case_by_id","name":"Get borrower case by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrower case by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"associations","in":"query","schemaId":"schema_5680","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of related object to return with the case data."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no references to related objects are inserted into the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", insert an array of all relations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise insert array of single type."},"children":[]}]}]}]}]},{"name":"include","in":"query","schemaId":"schema_5679","description":"A comma separated list of field names to include in the response.\n"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"associations","in":"query","required":false,"schemaId":"schema_5680"},{"name":"include","in":"query","schemaId":"schema_5679"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}","href":"cases/peach.cases.handlers.get_case_by_id","openApiOperationId":"peach.cases.handlers.get_case_by_id","summary":"Get borrower case by ID","securityGroups":[{"oauth2":["case:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}},"schemaId":"schema_5689"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.get_case_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}"},{"label":"Add association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.add_case_association","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.add_case_association","metadata":{"seo":{"title":"Add association","description":"Associate an existing case, interaction, loan, or file objects to the case.This way you can create comprehensive view of the case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.add_case_association","name":"Add association","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associate an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects to the case."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This way you can create comprehensive view of the case."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.association:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseAssociation"}},"schemaId":"components/schemas/CaseAssociation","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.association:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseAssociation"}},"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}","href":"cases/peach.cases.handlers.add_case_association","openApiOperationId":"peach.cases.handlers.add_case_association","summary":"Add association","securityGroups":[{"oauth2":["case.association:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseAssociation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseAssociation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.add_case_association"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}"},{"label":"Update case","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.update_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.update_case","metadata":{"seo":{"title":"Update case","description":"Update a case associated with a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.update_case","name":"Update case","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a case associated with a borrower.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasePut"}},"schemaId":"components/schemas/CasePut","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/cases/{caseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CasePut"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}","href":"cases/peach.cases.handlers.update_case","openApiOperationId":"peach.cases.handlers.update_case","summary":"Update case","securityGroups":[{"oauth2":["case:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CasePut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasePut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}},"schemaId":"schema_5689"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5689"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.update_case"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}"},{"label":"List case escalations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_get","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_get","metadata":{"seo":{"title":"List case escalations","description":"List case escalations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.escalations.handlers.case_escalations_get","name":"List case escalations","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List case escalations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List case escalations\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/escalations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/escalations","href":"cases/peach.cases.escalations.handlers.case_escalations_get","openApiOperationId":"peach.cases.escalations.handlers.case_escalations_get","summary":"List case escalations","securityGroups":[{"oauth2":["case:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5692"}},"schemaId":"schema_5692"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5692","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5692"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.escalations.handlers.case_escalations_get"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/escalations"},{"label":"Escalate or de-escalate a case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_create","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_create","metadata":{"seo":{"title":"Escalate or de-escalate a case","description":"Escalate or de-escalate a case"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.escalations.handlers.case_escalations_create","name":"Escalate or de-escalate a case","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Escalate or de-escalate a case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Escalate or de-escalate a case\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseEscalation"}},"schemaId":"components/schemas/CaseEscalation","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}/escalations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseEscalation"}},"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}/escalations","href":"cases/peach.cases.escalations.handlers.case_escalations_create","openApiOperationId":"peach.cases.escalations.handlers.case_escalations_create","summary":"Escalate or de-escalate a case","securityGroups":[{"oauth2":["case:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseEscalation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseEscalation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.escalations.handlers.case_escalations_create"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/escalations"},{"label":"List case escalation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalation_get_by_id","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalation_get_by_id","metadata":{"seo":{"title":"List case escalation by ID","description":"List case escalations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.escalations.handlers.case_escalation_get_by_id","name":"List case escalation by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations~1{caseEscalationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List case escalation by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List case escalations\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"caseEscalationId","in":"path","schemaId":"schema_5625","description":"The case escalation object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations~1{caseEscalationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/escalations/{caseEscalationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseEscalationId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/escalations/{caseEscalationId}","href":"cases/peach.cases.escalations.handlers.case_escalation_get_by_id","openApiOperationId":"peach.cases.escalations.handlers.case_escalation_get_by_id","summary":"List case escalation by ID","securityGroups":[{"oauth2":["case:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaseEscalationDetailed"}},"schemaId":"components/schemas/CaseEscalationDetailed"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1escalations~1{caseEscalationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CaseEscalationDetailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaseEscalationDetailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.escalations.handlers.case_escalation_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/escalations/{caseEscalationId}"},{"label":"Snooze case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.snooze_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.snooze_case","metadata":{"seo":{"title":"Snooze case","description":"Snooze the case or cancel the case snooze."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.snooze_case","name":"Snooze case","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1snooze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Snooze case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Snooze the case or cancel the case snooze.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:snooze"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1snooze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5693"}},"schemaId":"schema_5693","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1snooze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}/snooze","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:snooze"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5693"}},"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}/snooze","href":"cases/peach.cases.handlers.snooze_case","openApiOperationId":"peach.cases.handlers.snooze_case","summary":"Snooze case","securityGroups":[{"oauth2":["case:snooze"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5693","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5693"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1snooze/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.snooze_case"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/snooze"},{"label":"Mark a case as viewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.view_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.view_case","metadata":{"seo":{"title":"Mark a case as viewed","description":"Mark a case as viewed by the current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.handlers.view_case","name":"Mark a case as viewed","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1views/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark a case as viewed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a case as viewed by the current user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1views/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}/views","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}/views","href":"cases/peach.cases.handlers.view_case","openApiOperationId":"peach.cases.handlers.view_case","summary":"Mark a case as viewed","securityGroups":[{"oauth2":["case:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully marked case as viewed"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1views/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cases/peach.cases.handlers.view_case"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/views"}],"content":{"contentType":"group","meta":{"name":"Cases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cases","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to add cases to a borrower that are relevant to servicing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or collections. For example, a bankruptcy case. A borrower can have multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cases. If you enabled Compliance Guard monitoring feature, we'll create a new case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every time a borrower matches to one of the external data sources we use. For example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if you monitor for active military, and we match one of your borrowers to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the SCRA (https://scra.dmdc.osd.mil/scra/) database we'll create a new case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with type="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"militaryDuty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/active-escalations","summary":"List active case escalations for a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","deprecated":false},{"title":"/cases","summary":"Get all cases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.handlers.list_cases_by_company","deprecated":false},{"title":"/people/{personId}/cases","summary":"Get borrower cases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.handlers.list_cases_by_borrower","deprecated":false},{"title":"/people/{personId}/cases","summary":"Create borrower case","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/peach.cases.handlers.create_case","deprecated":false},{"title":"/people/{personId}/cases/{caseId}","summary":"Remove association","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cases/peach.cases.handlers.remove_case_association","deprecated":false},{"title":"/people/{personId}/cases/{caseId}","summary":"Get borrower case by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.handlers.get_case_by_id","deprecated":false},{"title":"/people/{personId}/cases/{caseId}","summary":"Add association","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/peach.cases.handlers.add_case_association","deprecated":false},{"title":"/people/{personId}/cases/{caseId}","summary":"Update case","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cases/peach.cases.handlers.update_case","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/escalations","summary":"List case escalations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.escalations.handlers.case_escalations_get","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/escalations","summary":"Escalate or de-escalate a case","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/peach.cases.escalations.handlers.case_escalations_create","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/escalations/{caseEscalationId}","summary":"List case escalation by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cases/peach.cases.escalations.handlers.case_escalation_get_by_id","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/snooze","summary":"Snooze case","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/peach.cases.handlers.snooze_case","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/views","summary":"Mark a case as viewed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cases/peach.cases.handlers.view_case","deprecated":false}]}]}]}]}},{"type":"group","label":"Case Types","link":"/api-docs/api-public/case-types","routeSlug":"/api-docs/api-public/case-types","items":[{"label":"Get case types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.list_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.list_case_type","metadata":{"seo":{"title":"Get case types","description":"Get case types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.list_case_type","name":"Get case types","isWebhook":false,"pointer":"/paths/~1case-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get case types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694","description":"Use this to limit results to a specific lender product."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"smartReviewsEnable","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Filter for case types that have enabled smart review tasks.\n"}],"pointer":"/paths/~1case-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/case-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"smartReviewsEnable","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/case-types","href":"case-types/peach.cases.case_types.handlers.list_case_type","openApiOperationId":"peach.cases.case_types.handlers.list_case_type","summary":"Get case types","securityGroups":[{"oauth2":["case.type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5695"}},"schemaId":"schema_5695"}],"pointer":"/paths/~1case-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5695","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5695"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.list_case_type"}],"panels":[]}]},"httpPath":"/case-types"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_case_type","metadata":{"seo":{"title":"Create type","description":"Create type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.create_case_type","name":"Create type","isWebhook":false,"pointer":"/paths/~1case-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseTypePostOnly"}},"schemaId":"components/schemas/CaseTypePostOnly","pointer":"/paths/~1case-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/case-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseTypePostOnly"}},"responseCodes":["200"],"pointer":"/case-types","href":"case-types/peach.cases.case_types.handlers.create_case_type","openApiOperationId":"peach.cases.case_types.handlers.create_case_type","summary":"Create type","securityGroups":[{"oauth2":["case.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseTypePostOnly","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseTypePostOnly"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}},"schemaId":"schema_5696"}],"pointer":"/paths/~1case-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5696","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.create_case_type"}],"panels":[]}]},"httpPath":"/case-types"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.get_case_type_by_id","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.get_case_type_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.get_case_type_by_id","name":"Get type by ID","isWebhook":false,"pointer":"/paths/~1case-types~1{caseTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1case-types~1{caseTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/case-types/{caseTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/case-types/{caseTypeId}","href":"case-types/peach.cases.case_types.handlers.get_case_type_by_id","openApiOperationId":"peach.cases.case_types.handlers.get_case_type_by_id","summary":"Get type by ID","securityGroups":[{"oauth2":["case.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}},"schemaId":"schema_5696"}],"pointer":"/paths/~1case-types~1{caseTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5696","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.get_case_type_by_id"}],"panels":[]}]},"httpPath":"/case-types/{caseTypeId}"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.update_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.update_case_type","metadata":{"seo":{"title":"Update type","description":"A PUT request is used to update an existing type configuration. While the type is in draft status requestscan move it to active. Setting the status to deprecated will immediately hide it from future GETall requests, and spawn a draft replica which can be edited and published in its place."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.update_case_type","name":"Update type","isWebhook":false,"pointer":"/paths/~1case-types~1{caseTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request is used to update an existing type configuration. While the type is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status requests"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can move it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will immediately hide it from future "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all requests, and spawn a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replica which can be edited and published in its place."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1case-types~1{caseTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseType"}},"schemaId":"components/schemas/CaseType","pointer":"/paths/~1case-types~1{caseTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/case-types/{caseTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseType"}},"responseCodes":["200"],"pointer":"/case-types/{caseTypeId}","href":"case-types/peach.cases.case_types.handlers.update_case_type","openApiOperationId":"peach.cases.case_types.handlers.update_case_type","summary":"Update type","securityGroups":[{"oauth2":["case.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}},"schemaId":"schema_5696"}],"pointer":"/paths/~1case-types~1{caseTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5696","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5696"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.update_case_type"}],"panels":[]}]},"httpPath":"/case-types/{caseTypeId}"},{"label":"Remove association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_remove_association","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_remove_association","metadata":{"seo":{"title":"Remove association","description":"Remove association"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.case_type_remove_association","name":"Remove association","isWebhook":false,"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type.association:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"objectType","in":"query","schemaId":"schema_5698","required":true},{"name":"objectId","in":"query","schemaId":"schema_5697","description":"The ID of the object to dissociate from","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/case-types/{caseTypeId}/associations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"objectType","in":"query","required":true,"schemaId":"schema_5698"},{"name":"objectId","in":"query","required":true,"schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type.association:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/case-types/{caseTypeId}/associations","href":"case-types/peach.cases.case_types.handlers.case_type_remove_association","openApiOperationId":"peach.cases.case_types.handlers.case_type_remove_association","summary":"Remove association","securityGroups":[{"oauth2":["case.type.association:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.case_type_remove_association"}],"panels":[]}]},"httpPath":"/case-types/{caseTypeId}/associations"},{"label":"Add association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_add_association","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_add_association","metadata":{"seo":{"title":"Add association","description":"Add association"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.case_type_add_association","name":"Add association","isWebhook":false,"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case.type.association:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"objectType","in":"query","schemaId":"schema_5698","required":true},{"name":"objectId","in":"query","schemaId":"schema_5697","description":"The ID of the object to associate with","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/case-types/{caseTypeId}/associations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"objectType","in":"query","required":true,"schemaId":"schema_5698"},{"name":"objectId","in":"query","required":true,"schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case.type.association:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/case-types/{caseTypeId}/associations","href":"case-types/peach.cases.case_types.handlers.case_type_add_association","openApiOperationId":"peach.cases.case_types.handlers.case_type_add_association","summary":"Add association","securityGroups":[{"oauth2":["case.type.association:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1case-types~1{caseTypeId}~1associations/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.case_type_add_association"}],"panels":[]}]},"httpPath":"/case-types/{caseTypeId}/associations"},{"label":"Create case type review tasks for ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_smart_review_tasks","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_smart_review_tasks","metadata":{"seo":{"title":"Create case type review tasks for ID","description":"Create case type review tasks for ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.case_types.handlers.create_smart_review_tasks","name":"Create case type review tasks for ID","isWebhook":false,"pointer":"/paths/~1case-types~1{caseTypeId}~1create-smart-review-tasks/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create case type review tasks for ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseTypeId","in":"path","schemaId":"schema_5625","description":"The case type unique identifier.\n","required":true}],"pointer":"/paths/~1case-types~1{caseTypeId}~1create-smart-review-tasks/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"asOfDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What date to process smart review criterion. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", process today. Can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not be a date in the future."},"children":[]}]}]}]}],"pointer":"/paths/~1case-types~1{caseTypeId}~1create-smart-review-tasks/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/case-types/{caseTypeId}/create-smart-review-tasks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"caseTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"asOfDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","201"],"pointer":"/case-types/{caseTypeId}/create-smart-review-tasks","href":"case-types/peach.cases.case_types.handlers.create_smart_review_tasks","openApiOperationId":"peach.cases.case_types.handlers.create_smart_review_tasks","summary":"Create case type review tasks for ID","securityGroups":[{"oauth2":["case:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Run successful with no reminder tasks created"},{"code":"201","description":"Run successful with created reminder tasks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5699"}},"schemaId":"schema_5699"}],"pointer":"/paths/~1case-types~1{caseTypeId}~1create-smart-review-tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"schema_5699","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5699"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case-types/peach.cases.case_types.handlers.create_smart_review_tasks"}],"panels":[]}]},"httpPath":"/case-types/{caseTypeId}/create-smart-review-tasks"}],"content":{"contentType":"group","meta":{"name":"Case Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Case Types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to create custom case types. You then can create case instances from a case type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach has a predefined collection of special case types,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and more. You can use any of the special types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as your base case type. To customize your case type you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add additional custom fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add and remove automatic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add custom name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add custom description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't want to use any of the special predefined case types, then use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as your base type."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/case-types","summary":"Get case types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.list_case_type","deprecated":false},{"title":"/case-types","summary":"Create type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.create_case_type","deprecated":false},{"title":"/case-types/{caseTypeId}","summary":"Get type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.get_case_type_by_id","deprecated":false},{"title":"/case-types/{caseTypeId}","summary":"Update type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.update_case_type","deprecated":false},{"title":"/case-types/{caseTypeId}/associations","summary":"Remove association","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.case_type_remove_association","deprecated":false},{"title":"/case-types/{caseTypeId}/associations","summary":"Add association","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.case_type_add_association","deprecated":false},{"title":"/case-types/{caseTypeId}/create-smart-review-tasks","summary":"Create case type review tasks for ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case-types/peach.cases.case_types.handlers.create_smart_review_tasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Smart Reviews","link":"/api-docs/api-public/smart-reviews","routeSlug":"/api-docs/api-public/smart-reviews","items":[{"type":"link","label":"Key Dates","link":"/api-docs/api-public/smart-reviews/key-dates","routeSlug":"/api-docs/api-public/smart-reviews/key-dates","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Key Dates"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"smart-reviews/key-dates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Dates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For most case types, configuration revolves around 'key dates' and you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify when you want a reminder task to be created relative to these key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /case-type/{caseTypeId}\n\n// returns something like...\n\n{\n        \"caseType\": \"militaryDuty\",\n        // <other fields ...>\n        \"smartReviews\": {\n                \"enable\": true,\n                \"config\": {\n                        \"keyDates\": {\n                                \"dutyStartDate\": 0,\n                                \"dutyEndDate\": 0,\n                        }\n                }\n        }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /case-type/{caseTypeId}\n\n// returns something like...\n\n{\n        \"caseType\": \"militaryDuty\",\n        // <other fields ...>\n        \"smartReviews\": {\n                \"enable\": true,\n                \"config\": {\n                        \"keyDates\": {\n                                \"dutyStartDate\": 0,\n                                \"dutyEndDate\": 0,\n                        }\n                }\n        }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key dates offsets can be expressed as an integer or array of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integers. Whenever "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(keyDateFieldValue + offset) == today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then a review"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task will be created. That is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an offset of 0, create a task on the key date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an offset of -1, create a task the day before the key date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an offset of 1, create a task the day after the key date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and so on. This math is based on calendar days and not business days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of base case types that use key dates and their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported key date fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"courtCaseClosedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditorClaimDeadlineDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"anticipatedCaseCompletionDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBureauDispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseDueDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidation"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceased"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceasedNoticeReceivedDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebt"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noticeReceivedDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheft"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportReceivedDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalAction"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalActionIntiatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalJudgementEffectiveDate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"militaryDuty"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dutyStartDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dutyEndDate"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Collections","link":"/api-docs/api-public/smart-reviews/collections","routeSlug":"/api-docs/api-public/smart-reviews/collections","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"smart-reviews/collections"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type cases operate on a different set of rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectsPreventingReminderTasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an array of any combination"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the following string values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dni"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledCall"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snooze"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If present in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectsPreventingReminderTasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the associated object will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cause a task to not be created if it exists; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"dni\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will prevent a new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task when the borrower has a DNI, and so on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastOutboundInteractionThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a positive integer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicating how many calendar days after the last outbound interaction to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wait until creating a reminder task. If this field is 3, and the last"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction was sent 3/20, then a reminder will be created on 3/23"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(assuming nothing otherwise prevents a task from being created)."},"children":[]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Smart Reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Smart Reviews","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Smart Reviews system allows for creating reminder tasks in the Peach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRM based on certain key events or triggers. For example, a trigger could"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be when a borrower starts military service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At creation time, all case types are supplied with a default smart review"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration that is disabled by default. Smart review tasks can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled by setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smartReviews.enable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smart-reviews"}],"panels":[]}]}},{"type":"group","label":"Supercases","link":"/api-docs/api-public/supercases","routeSlug":"/api-docs/api-public/supercases","items":[{"label":"List supercases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_list","metadata":{"seo":{"title":"List supercases","description":"List supercases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_list","name":"List supercases","isWebhook":false,"pointer":"/paths/~1supercases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List supercases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"sortBy","in":"query","schemaId":"schema_5700","description":"The attribute by which to sort the results."},{"name":"supercaseType","in":"query","schemaId":"schema_5701","description":"The type of the supercase"},{"name":"femaDisasterNumber","in":"query","schemaId":"schema_5702"},{"name":"status","in":"query","schemaId":"schema_5703"}],"pointer":"/paths/~1supercases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5700"},{"name":"supercaseType","in":"query","schemaId":"components/schemas/SupercaseType"},{"name":"femaDisasterNumber","in":"query","schemaId":"schema_5702"},{"name":"status","in":"query","schemaId":"schema_5703"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases","href":"supercases/peach.supercases.handlers.supercase_list","openApiOperationId":"peach.supercases.handlers.supercase_list","summary":"List supercases","securityGroups":[{"oauth2":["supercase:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5704"}},"schemaId":"schema_5704"}],"pointer":"/paths/~1supercases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5704","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5704"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_list"}],"panels":[]}]},"httpPath":"/supercases"},{"label":"Create supercase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_create","metadata":{"seo":{"title":"Create supercase","description":"Creates a new supercase."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_create","name":"Create supercase","isWebhook":false,"pointer":"/paths/~1supercases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new supercase."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5705"}},"schemaId":"schema_5705","pointer":"/paths/~1supercases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5705"}},"responseCodes":["200"],"pointer":"/supercases","href":"supercases/peach.supercases.handlers.supercase_create","openApiOperationId":"peach.supercases.handlers.supercase_create","summary":"Create supercase","securityGroups":[{"oauth2":["supercase:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5705","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5705"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}},"schemaId":"schema_5706"}],"pointer":"/paths/~1supercases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5706","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_create"}],"panels":[]}]},"httpPath":"/supercases"},{"label":"Get supercase members.csv template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_members_template_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_members_template_csv","metadata":{"seo":{"title":"Get supercase members.csv template","description":"Get supercase members.csv template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_members_template_csv","name":"Get supercase members.csv template","isWebhook":false,"pointer":"/paths/~1supercases~1members-template.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get supercase members.csv template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/members-template.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/members-template.csv","href":"supercases/peach.supercases.handlers.supercase_members_template_csv","openApiOperationId":"peach.supercases.handlers.supercase_members_template_csv","summary":"Get supercase members.csv template","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_5661"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1supercases~1members-template.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_5661"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_members_template_csv"}],"panels":[]}]},"httpPath":"/supercases/members-template.csv"},{"label":"Get supercase by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_get","metadata":{"seo":{"title":"Get supercase by ID","description":"Get supercase by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_get","name":"Get supercase by ID","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get supercase by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}","href":"supercases/peach.supercases.handlers.supercase_get","openApiOperationId":"peach.supercases.handlers.supercase_get","summary":"Get supercase by ID","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}},"schemaId":"schema_5706"}],"pointer":"/paths/~1supercases~1{supercaseId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5706","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}"},{"label":"Update supercase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_update","metadata":{"seo":{"title":"Update supercase","description":"Update supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_update","name":"Update supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Supercase"}},"schemaId":"components/schemas/Supercase","pointer":"/paths/~1supercases~1{supercaseId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Supercase"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}","href":"supercases/peach.supercases.handlers.supercase_update","openApiOperationId":"peach.supercases.handlers.supercase_update","summary":"Update supercase","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Supercase","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Supercase"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}},"schemaId":"schema_5706"}],"pointer":"/paths/~1supercases~1{supercaseId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5706","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5706"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_update"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}"},{"label":"Create Do Not Interact instances on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_create_dni","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_create_dni","metadata":{"seo":{"title":"Create Do Not Interact instances on all subcases","description":"Create Do Not Interact instances on all subcases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_create_dni","name":"Create Do Not Interact instances on all subcases","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-create-do-not-interact/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Do Not Interact instances on all subcases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:bulk.create.dni"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-create-do-not-interact/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"schemaId":"components/schemas/DoNotInteract","pointer":"/paths/~1supercases~1{supercaseId}~1bulk-create-do-not-interact/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/bulk-create-do-not-interact","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:bulk.create.dni"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"responseCodes":["202"],"pointer":"/supercases/{supercaseId}/bulk-create-do-not-interact","href":"supercases/peach.supercases.handlers.supercase_bulk_create_dni","openApiOperationId":"peach.supercases.handlers.supercase_bulk_create_dni","summary":"Create Do Not Interact instances on all subcases","securityGroups":[{"oauth2":["supercase:bulk.create.dni"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DoNotInteract","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}},"schemaId":"schema_5707"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-create-do-not-interact/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5707","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_create_dni"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-create-do-not-interact"},{"label":"Delete supercase related Do Not Interact instances on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_delete_dni","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_delete_dni","metadata":{"seo":{"title":"Delete supercase related Do Not Interact instances on all subcases","description":"Delete supercase related Do Not Interact instances on all subcases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_delete_dni","name":"Delete supercase related Do Not Interact instances on all subcases","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-delete-do-not-interact/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete supercase related Do Not Interact instances on all subcases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:bulk.delete.dni"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-delete-do-not-interact/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/bulk-delete-do-not-interact","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:bulk.delete.dni"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/supercases/{supercaseId}/bulk-delete-do-not-interact","href":"supercases/peach.supercases.handlers.supercase_bulk_delete_dni","openApiOperationId":"peach.supercases.handlers.supercase_bulk_delete_dni","summary":"Delete supercase related Do Not Interact instances on all subcases","securityGroups":[{"oauth2":["supercase:bulk.delete.dni"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}},"schemaId":"schema_5707"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-delete-do-not-interact/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5707","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_delete_dni"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-delete-do-not-interact"},{"label":"List bulk operations on this supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_list","metadata":{"seo":{"title":"List bulk operations on this supercase","description":"List bulk operations on this supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_operation_list","name":"List bulk operations on this supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk operations on this supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"operationTypes","in":"query","schemaId":"schema_5708","description":"List of desired operation types.\n"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/bulk-operations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"operationTypes","in":"query","required":false,"schemaId":"schema_5708"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/bulk-operations","href":"supercases/peach.supercases.handlers.supercase_bulk_operation_list","openApiOperationId":"peach.supercases.handlers.supercase_bulk_operation_list","summary":"List bulk operations on this supercase","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5709"}},"schemaId":"schema_5709"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5709","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5709"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_operation_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-operations"},{"label":"Search bulk operations on this supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_search","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_search","metadata":{"seo":{"title":"Search bulk operations on this supercase","description":"Search bulk operations on this supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_operation_search","name":"Search bulk operations on this supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search bulk operations on this supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/bulk-operations/search","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/bulk-operations/search","href":"supercases/peach.supercases.handlers.supercase_bulk_operation_search","openApiOperationId":"peach.supercases.handlers.supercase_bulk_operation_search","summary":"Search bulk operations on this supercase","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5710"}},"schemaId":"schema_5710"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5710","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5710"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_operation_search"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-operations/search"},{"label":"Get supercase bulk operation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_get","metadata":{"seo":{"title":"Get supercase bulk operation by ID","description":"Get supercase bulk operation by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_operation_get","name":"Get supercase bulk operation by ID","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get supercase bulk operation by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"supercaseBulkOperationId","in":"path","schemaId":"components/schemas/newStatus","description":"Supercase bulk operation ID","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"supercaseBulkOperationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}","href":"supercases/peach.supercases.handlers.supercase_bulk_operation_get","openApiOperationId":"peach.supercases.handlers.supercase_bulk_operation_get","summary":"Get supercase bulk operation by ID","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SupercaseBulkOperation"}},"schemaId":"components/schemas/SupercaseBulkOperation"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SupercaseBulkOperation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SupercaseBulkOperation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_operation_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}"},{"label":"Get member bulk operation results by operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","metadata":{"seo":{"title":"Get member bulk operation results by operation","description":"Returns a list of member bulk operation results for the supercase bulk operation. Each member bulk operation result represents a member that was affected by the operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.get_member_bulk_operation_results_by_operation","name":"Get member bulk operation results by operation","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1member-bulk-operation-results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get member bulk operation results by operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of member bulk operation results for the supercase bulk operation. Each member bulk operation result represents a member that was affected by the operation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"supercaseBulkOperationId","in":"path","schemaId":"components/schemas/newStatus","description":"Supercase bulk operation ID","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1member-bulk-operation-results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"status","in":"query","schemaId":"schema_5711","description":"Filter by status. Possible values are success, failed, ineligible, notProcessed.\n"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1member-bulk-operation-results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"supercaseBulkOperationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"status","in":"query","required":false,"schemaId":"schema_5711"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results","href":"supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","openApiOperationId":"peach.supercases.handlers.get_member_bulk_operation_results_by_operation","summary":"Get member bulk operation results by operation","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5712"}},"schemaId":"schema_5712"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1member-bulk-operation-results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5712","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5712"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results"},{"label":"Get target populations for the supercase bulk operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.get_bulk_operation_target_populations","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.get_bulk_operation_target_populations","metadata":{"seo":{"title":"Get target populations for the supercase bulk operation","description":"Returns a list of target populations for the supercase bulk operation. Each target population represents a set of members that will be affected by the operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.get_bulk_operation_target_populations","name":"Get target populations for the supercase bulk operation","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1target-populations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get target populations for the supercase bulk operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of target populations for the supercase bulk operation. Each target population represents a set of members that will be affected by the operation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"supercaseBulkOperationId","in":"path","schemaId":"components/schemas/newStatus","description":"Supercase bulk operation ID","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1target-populations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1target-populations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"supercaseBulkOperationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations","href":"supercases/peach.supercases.handlers.get_bulk_operation_target_populations","openApiOperationId":"peach.supercases.handlers.get_bulk_operation_target_populations","summary":"Get target populations for the supercase bulk operation","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5713"}},"schemaId":"schema_5713"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-operations~1{supercaseBulkOperationId}~1target-populations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5713","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5713"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.get_bulk_operation_target_populations"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations"},{"label":"Send a message to the borrowers on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_send_message","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_send_message","metadata":{"seo":{"title":"Send a message to the borrowers on all subcases","description":"Send a message to the borrowers on all subcases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_send_message","name":"Send a message to the borrowers on all subcases","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a message to the borrowers on all subcases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:bulk.send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"schemaId":"components/schemas/BulkSendRequestBody","pointer":"/paths/~1supercases~1{supercaseId}~1bulk-send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/bulk-send","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:bulk.send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"responseCodes":["202"],"pointer":"/supercases/{supercaseId}/bulk-send","href":"supercases/peach.supercases.handlers.supercase_bulk_send_message","openApiOperationId":"peach.supercases.handlers.supercase_bulk_send_message","summary":"Send a message to the borrowers on all subcases","securityGroups":[{"oauth2":["supercase:bulk.send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BulkSendRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}},"schemaId":"schema_5707"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5707","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_send_message"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-send"},{"label":"Update all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_update","metadata":{"seo":{"title":"Update all subcases","description":"Update all subcases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_bulk_update","name":"Update all subcases","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update all subcases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:bulk.update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasePut"}},"schemaId":"components/schemas/CasePut","pointer":"/paths/~1supercases~1{supercaseId}~1bulk-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/bulk-update","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:bulk.update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CasePut"}},"responseCodes":["202"],"pointer":"/supercases/{supercaseId}/bulk-update","href":"supercases/peach.supercases.handlers.supercase_bulk_update","openApiOperationId":"peach.supercases.handlers.supercase_bulk_update","summary":"Update all subcases","securityGroups":[{"oauth2":["supercase:bulk.update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CasePut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CasePut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}},"schemaId":"schema_5707"}],"pointer":"/paths/~1supercases~1{supercaseId}~1bulk-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5707","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_bulk_update"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/bulk-update"},{"label":"Get the number of cases associated with the supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_case_count","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_case_count","metadata":{"seo":{"title":"Get the number of cases associated with the supercase","description":"Get the number of cases associated with the supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.supercase_case_count","name":"Get the number of cases associated with the supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1case-count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the number of cases associated with the supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1case-count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/case-count","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/case-count","href":"supercases/peach.supercases.handlers.supercase_case_count","openApiOperationId":"peach.supercases.handlers.supercase_case_count","summary":"Get the number of cases associated with the supercase","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5714"}},"schemaId":"schema_5714"}],"pointer":"/paths/~1supercases~1{supercaseId}~1case-count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5714","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5714"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.supercase_case_count"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/case-count"},{"label":"Get the list of supercase documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.get_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.get_supercase_documents","metadata":{"seo":{"title":"Get the list of supercase documents","description":"Get the list of supercase documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.documents.get_supercase_documents","name":"Get the list of supercase documents","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the list of supercase documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fetchDetails","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns a list of document objects, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a list of document IDs."},"children":[]}]}]}]}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"fetchDetails","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/documents","href":"supercases/peach.supercases.handlers.documents.get_supercase_documents","openApiOperationId":"peach.supercases.handlers.documents.get_supercase_documents","summary":"Get the list of supercase documents","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5715"}},"schemaId":"schema_5715"}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5715"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.documents.get_supercase_documents"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/documents"},{"label":"Associate documents with the supercase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.add_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.add_supercase_documents","metadata":{"seo":{"title":"Associate documents with the supercase","description":"Associate documents with the supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.documents.add_supercase_documents","name":"Associate documents with the supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate documents with the supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5716"}},"schemaId":"schema_5716","pointer":"/paths/~1supercases~1{supercaseId}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5716"}},"responseCodes":["204"],"pointer":"/supercases/{supercaseId}/documents","href":"supercases/peach.supercases.handlers.documents.add_supercase_documents","openApiOperationId":"peach.supercases.handlers.documents.add_supercase_documents","summary":"Associate documents with the supercase","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5716","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5716"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.documents.add_supercase_documents"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/documents"},{"label":"Set the documents associated with the supercase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.set_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.set_supercase_documents","metadata":{"seo":{"title":"Set the documents associated with the supercase","description":"Set the documents associated with the supercase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.documents.set_supercase_documents","name":"Set the documents associated with the supercase","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1documents/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the documents associated with the supercase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5716"}},"schemaId":"schema_5716","pointer":"/paths/~1supercases~1{supercaseId}~1documents/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/documents","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5716"}},"responseCodes":["204"],"pointer":"/supercases/{supercaseId}/documents","href":"supercases/peach.supercases.handlers.documents.set_supercase_documents","openApiOperationId":"peach.supercases.handlers.documents.set_supercase_documents","summary":"Set the documents associated with the supercase","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5716","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5716"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1documents/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.documents.set_supercase_documents"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/documents"},{"label":"Get global notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_list","metadata":{"seo":{"title":"Get global notes","description":"Get global notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.global_note_list","name":"Get global notes","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get global notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/global-notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/global-notes","href":"supercases/peach.supercases.handlers.notes.global_note_list","openApiOperationId":"peach.supercases.handlers.notes.global_note_list","summary":"Get global notes","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.global_note_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/global-notes"},{"label":"Create global note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_create","metadata":{"seo":{"title":"Create global note","description":"Create global note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.global_note_create","name":"Create global note","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create global note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/global-notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/global-notes","href":"supercases/peach.supercases.handlers.notes.global_note_create","openApiOperationId":"peach.supercases.handlers.notes.global_note_create","summary":"Create global note","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.global_note_create"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/global-notes"},{"label":"Get global note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_get","metadata":{"seo":{"title":"Get global note by ID","description":"Get global note by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.global_note_get","name":"Get global note by ID","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get global note by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the note","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/global-notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/global-notes/{noteId}","href":"supercases/peach.supercases.handlers.notes.global_note_get","openApiOperationId":"peach.supercases.handlers.notes.global_note_get","summary":"Get global note by ID","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.global_note_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/global-notes/{noteId}"},{"label":"Update global note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_update","metadata":{"seo":{"title":"Update global note","description":"Update global note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.global_note_update","name":"Update global note","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update global note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the note","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/global-notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/global-notes/{noteId}","href":"supercases/peach.supercases.handlers.notes.global_note_update","openApiOperationId":"peach.supercases.handlers.notes.global_note_update","summary":"Update global note","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1global-notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.global_note_update"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/global-notes/{noteId}"},{"label":"Get private notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_list","metadata":{"seo":{"title":"Get private notes","description":"Get private notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.private_note_list","name":"Get private notes","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get private notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/notes","href":"supercases/peach.supercases.handlers.notes.private_note_list","openApiOperationId":"peach.supercases.handlers.notes.private_note_list","summary":"Get private notes","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.private_note_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/notes"},{"label":"Create private note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_create","metadata":{"seo":{"title":"Create private note","description":"Create private note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.private_note_create","name":"Create private note","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create private note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1supercases~1{supercaseId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/notes","href":"supercases/peach.supercases.handlers.notes.private_note_create","openApiOperationId":"peach.supercases.handlers.notes.private_note_create","summary":"Create private note","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.private_note_create"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/notes"},{"label":"Get private note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_get","metadata":{"seo":{"title":"Get private note by ID","description":"Get private note by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.private_note_get","name":"Get private note by ID","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get private note by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the note","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/notes/{noteId}","href":"supercases/peach.supercases.handlers.notes.private_note_get","openApiOperationId":"peach.supercases.handlers.notes.private_note_get","summary":"Get private note by ID","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.private_note_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/notes/{noteId}"},{"label":"Update private note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_update","metadata":{"seo":{"title":"Update private note","description":"Update private note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.notes.private_note_update","name":"Update private note","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update private note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the note","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/notes/{noteId}","href":"supercases/peach.supercases.handlers.notes.private_note_update","openApiOperationId":"peach.supercases.handlers.notes.private_note_update","summary":"Update private note","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1supercases~1{supercaseId}~1notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.notes.private_note_update"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/notes/{noteId}"},{"label":"List populations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_list","metadata":{"seo":{"title":"List populations","description":"List populations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_list","name":"List populations","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List populations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations","href":"supercases/peach.supercases.handlers.population_list","openApiOperationId":"peach.supercases.handlers.population_list","summary":"List populations","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5720"}},"schemaId":"schema_5720"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations"},{"label":"Get draft population","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_get","metadata":{"seo":{"title":"Get draft population","description":"Get draft population"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_get","name":"Get draft population","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draft population","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/draft","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft","href":"supercases/peach.supercases.handlers.draft_population_get","openApiOperationId":"peach.supercases.handlers.draft_population_get","summary":"Get draft population","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}},"schemaId":"schema_5721"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5721","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft"},{"label":"Commit draft population","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_commit","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_commit","metadata":{"seo":{"title":"Commit draft population","description":"Creates subcases for all members of the draft population and moves the population to the committed state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_commit","name":"Commit draft population","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1commit/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commit draft population","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates subcases for all members of the draft population and moves the population to the committed state.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1commit/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/populations/draft/commit","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/supercases/{supercaseId}/populations/draft/commit","href":"supercases/peach.supercases.handlers.draft_population_commit","openApiOperationId":"peach.supercases.handlers.draft_population_commit","summary":"Commit draft population","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1commit/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_commit"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/commit"},{"label":"Get the draft population members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list","metadata":{"seo":{"title":"Get the draft population members","description":"Get the draft population members"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_list","name":"Get the draft population members","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the draft population members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/draft/members","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members","href":"supercases/peach.supercases.handlers.draft_population_members_list","openApiOperationId":"peach.supercases.handlers.draft_population_members_list","summary":"Get the draft population members","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5722"}},"schemaId":"schema_5722"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5722"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members"},{"label":"Add to the draft population membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add","metadata":{"seo":{"title":"Add to the draft population membership","description":"Add to the current population membership the members in this request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_add","name":"Add to the draft population membership","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add to the draft population membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add to the current population membership the members in this request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"publishReviewTask","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create case update review task if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The task is created only when the user type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"schemaId":"components/schemas/PopulationMemberCollection","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/populations/draft/members","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"publishReviewTask","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members","href":"supercases/peach.supercases.handlers.draft_population_members_add","openApiOperationId":"peach.supercases.handlers.draft_population_members_add","summary":"Add to the draft population membership","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PopulationMemberCollection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_add"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members"},{"label":"Set the draft population membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set","metadata":{"seo":{"title":"Set the draft population membership","description":"Set the draft population membership to the population in this request. (Removing all current members if they exist.)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_set","name":"Set the draft population membership","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the draft population membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the draft population membership to the population in this request.\n(Removing all current members if they exist.)\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"publishReviewTask","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create case update review task if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The task is created only when the user type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"schemaId":"components/schemas/PopulationMemberCollection","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/populations/draft/members","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"publishReviewTask","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members","href":"supercases/peach.supercases.handlers.draft_population_members_set","openApiOperationId":"peach.supercases.handlers.draft_population_members_set","summary":"Set the draft population membership","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PopulationMemberCollection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PopulationMemberCollection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_set"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members"},{"label":"Get membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list_csv","metadata":{"seo":{"title":"Get membership as CSV","description":"Get membership as CSV"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_list_csv","name":"Get membership as CSV","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get membership as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/draft/members.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members.csv","href":"supercases/peach.supercases.handlers.draft_population_members_list_csv","openApiOperationId":"peach.supercases.handlers.draft_population_members_list_csv","summary":"Get membership as CSV","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_list_csv"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv"},{"label":"Add to membership with CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add_csv","metadata":{"seo":{"title":"Add to membership with CSV","description":"Add to the current population membership with the population in this request. Format is a CSV document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_add_csv","name":"Add to membership with CSV","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add to membership with CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add to the current population membership with the population in this request.\nFormat is a CSV document.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_5661"}},"schemaId":"schema_5661","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/populations/draft/members.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/octet-stream":{"schemaId":"schema_5661"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members.csv","href":"supercases/peach.supercases.handlers.draft_population_members_add_csv","openApiOperationId":"peach.supercases.handlers.draft_population_members_add_csv","summary":"Add to membership with CSV","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5661","mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_5661"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_add_csv"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv"},{"label":"Set membership with CSV","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set_csv","metadata":{"seo":{"title":"Set membership with CSV","description":"Set the current population membership to the population in this request. (Removing all current members if they exist.) Format is a CSV document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.draft_population_members_set_csv","name":"Set membership with CSV","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set membership with CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the current population membership to the population in this request. (Removing\nall current members if they exist.) Format is a CSV document.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_5661"}},"schemaId":"schema_5661","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/populations/draft/members.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/octet-stream":{"schemaId":"schema_5661"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/draft/members.csv","href":"supercases/peach.supercases.handlers.draft_population_members_set_csv","openApiOperationId":"peach.supercases.handlers.draft_population_members_set_csv","summary":"Set membership with CSV","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5661","mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_5661"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1draft~1members.csv/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.draft_population_members_set_csv"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv"},{"label":"Get committed membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.committed_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.committed_members_list_csv","metadata":{"seo":{"title":"Get committed membership as CSV","description":"Get committed membership as CSV"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.committed_members_list_csv","name":"Get committed membership as CSV","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1members.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get committed membership as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1members.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/members.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/members.csv","href":"supercases/peach.supercases.handlers.committed_members_list_csv","openApiOperationId":"peach.supercases.handlers.committed_members_list_csv","summary":"Get committed membership as CSV","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1members.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.committed_members_list_csv"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/members.csv"},{"label":"Get population by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_get","metadata":{"seo":{"title":"Get population by ID","description":"Get population by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_get","name":"Get population by ID","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get population by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"populationId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the population","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/{populationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"populationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/{populationId}","href":"supercases/peach.supercases.handlers.population_get","openApiOperationId":"peach.supercases.handlers.population_get","summary":"Get population by ID","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}},"schemaId":"schema_5721"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5721","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_get"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/{populationId}"},{"label":"Update population","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_update","metadata":{"seo":{"title":"Update population","description":"Update the population."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_update","name":"Update population","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update population","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the population."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"populationId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the population","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Population"}},"schemaId":"components/schemas/Population","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/supercases/{supercaseId}/populations/{populationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"populationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Population"}},"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/{populationId}","href":"supercases/peach.supercases.handlers.population_update","openApiOperationId":"peach.supercases.handlers.population_update","summary":"Update population","securityGroups":[{"oauth2":["supercase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Population","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Population"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}},"schemaId":"schema_5721"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5721","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5721"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_update"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/{populationId}"},{"label":"Send a message to the borrowers on all subcases of the population","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_bulk_send_message","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_bulk_send_message","metadata":{"seo":{"title":"Send a message to the borrowers on all subcases of the population","description":"Send a message to the borrowers on all subcases of the population"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_bulk_send_message","name":"Send a message to the borrowers on all subcases of the population","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1bulk-send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a message to the borrowers on all subcases of the population","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:bulk.send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"populationId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the population","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1bulk-send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"schemaId":"components/schemas/BulkSendRequestBody","pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1bulk-send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/supercases/{supercaseId}/populations/{populationId}/bulk-send","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"populationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:bulk.send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"responseCodes":["202"],"pointer":"/supercases/{supercaseId}/populations/{populationId}/bulk-send","href":"supercases/peach.supercases.handlers.population_bulk_send_message","openApiOperationId":"peach.supercases.handlers.population_bulk_send_message","summary":"Send a message to the borrowers on all subcases of the population","securityGroups":[{"oauth2":["supercase:bulk.send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BulkSendRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkSendRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}},"schemaId":"schema_5707"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1bulk-send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5707","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5707"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_bulk_send_message"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/bulk-send"},{"label":"Get population membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list","metadata":{"seo":{"title":"Get population membership","description":"Get population membership"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_members_list","name":"Get population membership","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get population membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"populationId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the population","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/{populationId}/members","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"populationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/{populationId}/members","href":"supercases/peach.supercases.handlers.population_members_list","openApiOperationId":"peach.supercases.handlers.population_members_list","summary":"Get population membership","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5722"}},"schemaId":"schema_5722"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5722"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_members_list"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/members"},{"label":"Get membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list_csv","metadata":{"seo":{"title":"Get membership as CSV","description":"Get membership as CSV"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.supercases.handlers.population_members_list_csv","name":"Get membership as CSV","isWebhook":false,"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get membership as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["supercase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"supercaseId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the supercase","required":true},{"name":"populationId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the population","required":true}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/supercases/{supercaseId}/populations/{populationId}/members.csv","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"supercaseId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"populationId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["supercase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/supercases/{supercaseId}/populations/{populationId}/members.csv","href":"supercases/peach.supercases.handlers.population_members_list_csv","openApiOperationId":"peach.supercases.handlers.population_members_list_csv","summary":"Get membership as CSV","securityGroups":[{"oauth2":["supercase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1supercases~1{supercaseId}~1populations~1{populationId}~1members.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["application/octet-stream","text/csv"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_5661"},"text/csv":{"schemaId":"schema_5661"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supercases/peach.supercases.handlers.population_members_list_csv"}],"panels":[]}]},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/members.csv"}],"content":{"contentType":"group","meta":{"name":"Supercases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Supercases","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows for the management of many cases across a number of borrowers. That is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to say that a supercase can create, manage, and close many cases at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is particularly useful if an issue occurs which affects a large group of borrowers."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cases created by a supercase are called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subcases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A supercase can only manage cases it has created (i.e., NOT cases created via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/cases"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing \"who\" is affected by a supercase is an important aspect of supercases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"member"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a supercase is one \"borrower-loan\" pairing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"population"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a set of members added at once."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A supercase might have many populations if different members are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"added at different times."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's useful to keep track of sets of members like this because different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actions might need to be taken on different members depending on when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they're added to a supercase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"population"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s membership may be changed until it is \"committed\" by setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDraft: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", at which time the memberships are locked and subcases are created."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/supercases","summary":"List supercases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_list","deprecated":false},{"title":"/supercases","summary":"Create supercase","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_create","deprecated":false},{"title":"/supercases/members-template.csv","summary":"Get supercase members.csv template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_members_template_csv","deprecated":false},{"title":"/supercases/{supercaseId}","summary":"Get supercase by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_get","deprecated":false},{"title":"/supercases/{supercaseId}","summary":"Update supercase","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_update","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-create-do-not-interact","summary":"Create Do Not Interact instances on all subcases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_create_dni","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-delete-do-not-interact","summary":"Delete supercase related Do Not Interact instances on all subcases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_delete_dni","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-operations","summary":"List bulk operations on this supercase","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_operation_list","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-operations/search","summary":"Search bulk operations on this supercase","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_operation_search","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}","summary":"Get supercase bulk operation by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_operation_get","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results","summary":"Get member bulk operation results by operation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations","summary":"Get target populations for the supercase bulk operation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.get_bulk_operation_target_populations","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-send","summary":"Send a message to the borrowers on all subcases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_send_message","deprecated":false},{"title":"/supercases/{supercaseId}/bulk-update","summary":"Update all subcases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_bulk_update","deprecated":false},{"title":"/supercases/{supercaseId}/case-count","summary":"Get the number of cases associated with the supercase","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.supercase_case_count","deprecated":false},{"title":"/supercases/{supercaseId}/documents","summary":"Get the list of supercase documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.documents.get_supercase_documents","deprecated":false},{"title":"/supercases/{supercaseId}/documents","summary":"Associate documents with the supercase","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.documents.add_supercase_documents","deprecated":false},{"title":"/supercases/{supercaseId}/documents","summary":"Set the documents associated with the supercase","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.documents.set_supercase_documents","deprecated":false},{"title":"/supercases/{supercaseId}/global-notes","summary":"Get global notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.global_note_list","deprecated":false},{"title":"/supercases/{supercaseId}/global-notes","summary":"Create global note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.global_note_create","deprecated":false},{"title":"/supercases/{supercaseId}/global-notes/{noteId}","summary":"Get global note by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.global_note_get","deprecated":false},{"title":"/supercases/{supercaseId}/global-notes/{noteId}","summary":"Update global note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.global_note_update","deprecated":false},{"title":"/supercases/{supercaseId}/notes","summary":"Get private notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.private_note_list","deprecated":false},{"title":"/supercases/{supercaseId}/notes","summary":"Create private note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.private_note_create","deprecated":false},{"title":"/supercases/{supercaseId}/notes/{noteId}","summary":"Get private note by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.private_note_get","deprecated":false},{"title":"/supercases/{supercaseId}/notes/{noteId}","summary":"Update private note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.notes.private_note_update","deprecated":false},{"title":"/supercases/{supercaseId}/populations","summary":"List populations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_list","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft","summary":"Get draft population","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_get","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/commit","summary":"Commit draft population","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_commit","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members","summary":"Get the draft population members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_list","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members","summary":"Add to the draft population membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_add","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members","summary":"Set the draft population membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_set","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members.csv","summary":"Get membership as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_list_csv","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members.csv","summary":"Add to membership with CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_add_csv","deprecated":false},{"title":"/supercases/{supercaseId}/populations/draft/members.csv","summary":"Set membership with CSV","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.draft_population_members_set_csv","deprecated":false},{"title":"/supercases/{supercaseId}/populations/members.csv","summary":"Get committed membership as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.committed_members_list_csv","deprecated":false},{"title":"/supercases/{supercaseId}/populations/{populationId}","summary":"Get population by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_get","deprecated":false},{"title":"/supercases/{supercaseId}/populations/{populationId}","summary":"Update population","prefix":{"name":"put","color":"put"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_update","deprecated":false},{"title":"/supercases/{supercaseId}/populations/{populationId}/bulk-send","summary":"Send a message to the borrowers on all subcases of the population","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_bulk_send_message","deprecated":false},{"title":"/supercases/{supercaseId}/populations/{populationId}/members","summary":"Get population membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_members_list","deprecated":false},{"title":"/supercases/{supercaseId}/populations/{populationId}/members.csv","summary":"Get membership as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/supercases/peach.supercases.handlers.population_members_list_csv","deprecated":false}]}]}]}]}},{"type":"group","label":"Do Not Interact","link":"/api-docs/api-public/do-not-interact","routeSlug":"/api-docs/api-public/do-not-interact","items":[{"label":"Get case do not interacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","metadata":{"seo":{"title":"Get case do not interacts","description":"Get the all DoNoInteract instances associated with a case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","name":"Get case do not interacts","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get case do not interacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNoInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instances associated with a case."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/do-not-interacts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/do-not-interacts","href":"do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","openApiOperationId":"peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","summary":"Get case do not interacts","securityGroups":[{"oauth2":["dni:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5723"}},"schemaId":"schema_5723"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5723"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts"},{"label":"Create do not interact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","metadata":{"seo":{"title":"Create do not interact","description":"Create do not interact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact.do_not_interact_create","name":"Create do not interact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create do not interact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"schemaId":"components/schemas/DoNotInteract","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}/do-not-interacts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/do-not-interacts","href":"do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","openApiOperationId":"peach.cases.events.handlers.do_not_interact.do_not_interact_create","summary":"Create do not interact","securityGroups":[{"oauth2":["dni:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DoNotInteract","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteract"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}},"schemaId":"schema_5724"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts"},{"label":"Remove do not interact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","metadata":{"seo":{"title":"Remove do not interact","description":"Update a DoNotInteract instance to have inactive status, and set the end date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact.do_not_interact_delete","name":"Remove do not interact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove do not interact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instance to have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, and set the end date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"doNotInteractId","in":"path","schemaId":"schema_5625","description":"The Do Not Interact object unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"doNotInteractId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","href":"do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","openApiOperationId":"peach.cases.events.handlers.do_not_interact.do_not_interact_delete","summary":"Remove do not interact","securityGroups":[{"oauth2":["dni:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}"},{"label":"Get do not interact by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","metadata":{"seo":{"title":"Get do not interact by ID","description":"Get a single DoNotInteract object instance for the borrower using a unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","name":"Get do not interact by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get do not interact by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object instance for the borrower using a unique ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"doNotInteractId","in":"path","schemaId":"schema_5625","description":"The Do Not Interact object unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"doNotInteractId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","href":"do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","openApiOperationId":"peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","summary":"Get do not interact by ID","securityGroups":[{"oauth2":["dni:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}},"schemaId":"schema_5724"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}"},{"label":"Update do not interact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","metadata":{"seo":{"title":"Update do not interact","description":"Update a DoNotInteract instance with new information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact.do_not_interact_update","name":"Update do not interact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update do not interact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instance with new information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"doNotInteractId","in":"path","schemaId":"schema_5625","description":"The Do Not Interact object unique identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractUpdate"}},"schemaId":"components/schemas/DoNotInteractUpdate","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"doNotInteractId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DoNotInteractUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","href":"do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","openApiOperationId":"peach.cases.events.handlers.do_not_interact.do_not_interact_update","summary":"Update do not interact","securityGroups":[{"oauth2":["dni:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DoNotInteractUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}},"schemaId":"schema_5724"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1do-not-interacts~1{doNotInteractId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5724"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}"},{"label":"Get all do not interacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","routeSlug":"/api-docs/api-public/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","metadata":{"seo":{"title":"Get all do not interacts","description":"Get the all DoNoInteract instances associated with a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.do_not_interact.handlers.do_not_interact_get_all","name":"Get all do not interacts","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1do-not-interacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all do not interacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNoInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instances associated with a borrower."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1do-not-interacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1do-not-interacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/do-not-interacts","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/do-not-interacts","href":"do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","openApiOperationId":"peach.people.do_not_interact.handlers.do_not_interact_get_all","summary":"Get all do not interacts","securityGroups":[{"oauth2":["dni:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5723"}},"schemaId":"schema_5723"}],"pointer":"/paths/~1people~1{personId}~1do-not-interacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5723"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/do-not-interacts"}],"content":{"contentType":"group","meta":{"name":"Do Not Interact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Do Not Interact","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to block interactions on a borrower; and must be connected with a case. You can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create multiple Do Not Interact instances on a borrower but only one instance on a case. There are two ways"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to create Do Not Interacts:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually - after a case is created, you can manually create Do Not Interact objects on any borrower case."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In bulk on a Supercase, on the related subcases. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Supercases/operation/peach.supercases.handlers.supercase_bulk_create_dni"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Do Not Interact instances on all subcases"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/cases/{caseId}/do-not-interacts","summary":"Get case do not interacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/do-not-interacts","summary":"Create do not interact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","summary":"Remove do not interact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","summary":"Get do not interact by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","summary":"Update do not interact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","deprecated":false},{"title":"/people/{personId}/do-not-interacts","summary":"Get all do not interacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","deprecated":false}]}]}]}]}},{"type":"group","label":"Do Not Interact Types","link":"/api-docs/api-public/do-not-interact-types","routeSlug":"/api-docs/api-public/do-not-interact-types","items":[{"label":"Get types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","metadata":{"seo":{"title":"Get types","description":"Get types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","name":"Get types","isWebhook":false,"pointer":"/paths/~1do-not-interact-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni.type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694","description":"Use this to limit results to a specific lender product."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1do-not-interact-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/do-not-interact-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni.type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/do-not-interact-types","href":"do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","openApiOperationId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","summary":"Get types","securityGroups":[{"oauth2":["dni.type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5725"}},"schemaId":"schema_5725"}],"pointer":"/paths/~1do-not-interact-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5725"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all"}],"panels":[]}]},"httpPath":"/do-not-interact-types"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","metadata":{"seo":{"title":"Create type","description":"Create type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","name":"Create type","isWebhook":false,"pointer":"/paths/~1do-not-interact-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"typeId","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, will create a new type from the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1do-not-interact-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"schemaId":"components/schemas/DoNotInteractType","pointer":"/paths/~1do-not-interact-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/do-not-interact-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"typeId","in":"query","schemaId":"schema_5697"},{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"responseCodes":["200"],"pointer":"/do-not-interact-types","href":"do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","openApiOperationId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","summary":"Create type","securityGroups":[{"oauth2":["dni.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DoNotInteractType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}},"schemaId":"schema_5726"}],"pointer":"/paths/~1do-not-interact-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create"}],"panels":[]}]},"httpPath":"/do-not-interact-types"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","name":"Get type by ID","isWebhook":false,"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"doNotInteractTypeId","in":"path","schemaId":"schema_5702","description":"The Do Not Interact Type unique identifier.\n","required":true}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/do-not-interact-types/{doNotInteractTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"doNotInteractTypeId","in":"path","required":true,"schemaId":"schema_5702"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/do-not-interact-types/{doNotInteractTypeId}","href":"do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","openApiOperationId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","summary":"Get type by ID","securityGroups":[{"oauth2":["dni.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}},"schemaId":"schema_5726"}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id"}],"panels":[]}]},"httpPath":"/do-not-interact-types/{doNotInteractTypeId}"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","metadata":{"seo":{"title":"Update type","description":"Change the triggering conditions and settings of a draft type, or update the status of an activetype to deprecated. Doing the later will create a new draft version of the configuration unlessexplicitly told not to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","name":"Update type","isWebhook":false,"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the triggering conditions and settings of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, or update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Doing the later will create a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version of the configuration unless"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"explicitly told not to."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["dni.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"doNotInteractTypeId","in":"path","schemaId":"schema_5702","description":"The Do Not Interact Type unique identifier.\n","required":true}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"schemaId":"components/schemas/DoNotInteractType","pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/do-not-interact-types/{doNotInteractTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"doNotInteractTypeId","in":"path","required":true,"schemaId":"schema_5702"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["dni.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"responseCodes":["200"],"pointer":"/do-not-interact-types/{doNotInteractTypeId}","href":"do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","openApiOperationId":"peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","summary":"Update type","securityGroups":[{"oauth2":["dni.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DoNotInteractType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DoNotInteractType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}},"schemaId":"schema_5726"}],"pointer":"/paths/~1do-not-interact-types~1{doNotInteractTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5726"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update"}],"panels":[]}]},"httpPath":"/do-not-interact-types/{doNotInteractTypeId}"}],"content":{"contentType":"group","meta":{"name":"Do Not Interact Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Do Not Interact Types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to create custom "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which will create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instances automatically when case conditions are met. For example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system can automatically create "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to block debt collection related interactions for 30 calendar days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conditions are set in the following way. There are two triggers and one condition fields that you can configure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - triggered based on the case status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - triggered based on the case outcome."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - condition(s) based on case fields values."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide at least one trigger, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when creating a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus=processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance will be created when the case status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus=completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome=approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance will be created when the case status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the outcome is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Do Not Interact Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be associated with multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/do-not-interact-types","summary":"Get types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","deprecated":false},{"title":"/do-not-interact-types","summary":"Create type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","deprecated":false},{"title":"/do-not-interact-types/{doNotInteractTypeId}","summary":"Get type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","deprecated":false},{"title":"/do-not-interact-types/{doNotInteractTypeId}","summary":"Update type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Notification Types","link":"/api-docs/api-public/notification-types","routeSlug":"/api-docs/api-public/notification-types","items":[{"label":"Get types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","metadata":{"seo":{"title":"Get types","description":"Get types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.notifications.notification_type_get_all","name":"Get types","isWebhook":false,"pointer":"/paths/~1notification-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["notification.type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694","description":"Use this to limit results to a specific lender product."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1notification-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"loanTypeId","in":"query","schemaId":"schema_5694"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["notification.type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/notification-types","href":"notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","openApiOperationId":"peach.cases.events.handlers.notifications.notification_type_get_all","summary":"Get types","securityGroups":[{"oauth2":["notification.type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5727"}},"schemaId":"schema_5727"}],"pointer":"/paths/~1notification-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5727"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all"}],"panels":[]}]},"httpPath":"/notification-types"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_create","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_create","metadata":{"seo":{"title":"Create type","description":"Create a new type configuration for triggering notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.notifications.notification_type_create","name":"Create type","isWebhook":false,"pointer":"/paths/~1notification-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new type configuration for triggering notifications.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["notification.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"typeId","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, will create a new type from the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1notification-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"schemaId":"components/schemas/NotificationType","pointer":"/paths/~1notification-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notification-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"typeId","in":"query","schemaId":"schema_5697"},{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["notification.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"responseCodes":["200"],"pointer":"/notification-types","href":"notification-types/peach.cases.events.handlers.notifications.notification_type_create","openApiOperationId":"peach.cases.events.handlers.notifications.notification_type_create","summary":"Create type","securityGroups":[{"oauth2":["notification.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NotificationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}},"schemaId":"schema_5728"}],"pointer":"/paths/~1notification-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-types/peach.cases.events.handlers.notifications.notification_type_create"}],"panels":[]}]},"httpPath":"/notification-types"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.notifications.notification_type_get_by_id","name":"Get type by ID","isWebhook":false,"pointer":"/paths/~1notification-types~1{notificationTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["notification.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationTypeId","in":"path","schemaId":"schema_5702","description":"The Notification Type unique identifier.\n","required":true}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-types/{notificationTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"notificationTypeId","in":"path","required":true,"schemaId":"schema_5702"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["notification.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/notification-types/{notificationTypeId}","href":"notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","openApiOperationId":"peach.cases.events.handlers.notifications.notification_type_get_by_id","summary":"Get type by ID","securityGroups":[{"oauth2":["notification.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}},"schemaId":"schema_5728"}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id"}],"panels":[]}]},"httpPath":"/notification-types/{notificationTypeId}"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_update","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_update","metadata":{"seo":{"title":"Update type","description":"Change the triggering conditions and settings of a draft type, or update the status of an activetype to deprecated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.cases.events.handlers.notifications.notification_type_update","name":"Update type","isWebhook":false,"pointer":"/paths/~1notification-types~1{notificationTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the triggering conditions and settings of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, or update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["notification.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationTypeId","in":"path","schemaId":"schema_5702","description":"The Notification Type unique identifier.\n","required":true}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5697","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional argument. If provided, the action will be performed on the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"schemaId":"components/schemas/NotificationType","pointer":"/paths/~1notification-types~1{notificationTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notification-types/{notificationTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"notificationTypeId","in":"path","required":true,"schemaId":"schema_5702"}],"query":[{"name":"version","in":"query","schemaId":"schema_5697"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["notification.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"responseCodes":["200"],"pointer":"/notification-types/{notificationTypeId}","href":"notification-types/peach.cases.events.handlers.notifications.notification_type_update","openApiOperationId":"peach.cases.events.handlers.notifications.notification_type_update","summary":"Update type","securityGroups":[{"oauth2":["notification.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NotificationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}},"schemaId":"schema_5728"}],"pointer":"/paths/~1notification-types~1{notificationTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5728"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-types/peach.cases.events.handlers.notifications.notification_type_update"}],"panels":[]}]},"httpPath":"/notification-types/{notificationTypeId}"}],"content":{"contentType":"group","meta":{"name":"Notification Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to create custom "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Notification Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which will create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instances (such as emails, text messages, etc.) automatically when case conditions are met. For example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system can automatically send an email notification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and ask the borrower to provide supporting documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conditions are set in the following way. There are two triggers and one condition fields that you can configure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - triggered based on the case status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - triggered based on the case outcome."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - condition(s) based on case fields values."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide at least one trigger, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when creating a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Notification Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus=processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance will be created when the case status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onStatus=completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onOutcome=approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onCondition=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance will be created when the case status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the outcome is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Notification Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Notification Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be associated with multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notification-types","summary":"Get types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","deprecated":false},{"title":"/notification-types","summary":"Create type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notification-types/peach.cases.events.handlers.notifications.notification_type_create","deprecated":false},{"title":"/notification-types/{notificationTypeId}","summary":"Get type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","deprecated":false},{"title":"/notification-types/{notificationTypeId}","summary":"Update type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notification-types/peach.cases.events.handlers.notifications.notification_type_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/api-docs/api-public/notes","routeSlug":"/api-docs/api-public/notes","items":[{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_interaction_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_interaction_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.list_interaction_notes","name":"Get notes","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"categories","in":"query","schemaId":"schema_5729","description":"Filters by the given note categories\n"},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions~1{interactionId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"categories","in":"query","schemaId":"schema_5729"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/notes","href":"notes/peach.notes.handlers.list_interaction_notes","openApiOperationId":"peach.notes.handlers.list_interaction_notes","summary":"Get notes","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1interactions~1{interactionId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.list_interaction_notes"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/notes"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_interaction_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.create_interaction_note","name":"Create note","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1interactions~1{interactionId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/interactions/{interactionId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/interactions/{interactionId}/notes","href":"notes/peach.notes.handlers.create_interaction_note","openApiOperationId":"peach.notes.handlers.create_interaction_note","summary":"Create note","securityGroups":[{"oauth2":["note:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1interactions~1{interactionId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.create_interaction_note"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/notes"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_interaction_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.get_interaction_note","name":"Get note by ID","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get note by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/notes/{noteId}","href":"notes/peach.notes.handlers.get_interaction_note","openApiOperationId":"peach.notes.handlers.get_interaction_note","summary":"Get note by ID","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.get_interaction_note"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/notes/{noteId}"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_interaction_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.update_interaction_note","name":"Update note","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/interactions/{interactionId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/interactions/{interactionId}/notes/{noteId}","href":"notes/peach.notes.handlers.update_interaction_note","openApiOperationId":"peach.notes.handlers.update_interaction_note","summary":"Update note","securityGroups":[{"oauth2":["note:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1interactions~1{interactionId}~1notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.update_interaction_note"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/notes/{noteId}"},{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_case_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_case_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.list_case_notes","name":"Get notes","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"categories","in":"query","schemaId":"schema_5729","description":"Filters by the given note categories\n"},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"categories","in":"query","schemaId":"schema_5729"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/notes","href":"notes/peach.notes.handlers.list_case_notes","openApiOperationId":"peach.notes.handlers.list_case_notes","summary":"Get notes","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.list_case_notes"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/notes"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_case_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.create_case_note","name":"Create note","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/cases/{caseId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/notes","href":"notes/peach.notes.handlers.create_case_note","openApiOperationId":"peach.notes.handlers.create_case_note","summary":"Create note","securityGroups":[{"oauth2":["note:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.create_case_note"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/notes"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_case_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.get_case_note","name":"Get note by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get note by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/cases/{caseId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/notes/{noteId}","href":"notes/peach.notes.handlers.get_case_note","openApiOperationId":"peach.notes.handlers.get_case_note","summary":"Get note by ID","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.get_case_note"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/notes/{noteId}"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_case_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.update_case_note","name":"Update note","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/cases/{caseId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/cases/{caseId}/notes/{noteId}","href":"notes/peach.notes.handlers.update_case_note","openApiOperationId":"peach.notes.handlers.update_case_note","summary":"Update note","securityGroups":[{"oauth2":["note:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1cases~1{caseId}~1notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.update_case_note"}],"panels":[]}]},"httpPath":"/people/{personId}/cases/{caseId}/notes/{noteId}"},{"label":"Get interaction notes for a person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_interaction_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_interaction_notes","metadata":{"seo":{"title":"Get interaction notes for a person","description":"Get interaction notes for a person"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.list_borrower_interaction_notes","name":"Get interaction notes for a person","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interaction-notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction notes for a person","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interaction-notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]},{"name":"channels","in":"query","schemaId":"schema_5687","description":"Only include notes for the interactions with the specified channels."}],"pointer":"/paths/~1people~1{personId}~1interaction-notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interaction-notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"},{"name":"channels","in":"query","required":false,"schemaId":"schema_5687"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interaction-notes","href":"notes/peach.notes.handlers.list_borrower_interaction_notes","openApiOperationId":"peach.notes.handlers.list_borrower_interaction_notes","summary":"Get interaction notes for a person","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1people~1{personId}~1interaction-notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.list_borrower_interaction_notes"}],"panels":[]}]},"httpPath":"/people/{personId}/interaction-notes"},{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.list_borrower_notes","name":"Get notes","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"categories","in":"query","schemaId":"schema_5729","description":"Filters by the given note categories\n"},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"Include archived notes into the result"},{"name":"pinned","in":"query","schemaId":"schema_5717","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", show only pinned notes. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exclude them. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do no filtering."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"categories","in":"query","schemaId":"schema_5729"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"includeArchived","in":"query","required":false,"schemaId":"schema_5623"},{"name":"pinned","in":"query","schemaId":"schema_5717"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/notes","href":"notes/peach.notes.handlers.list_borrower_notes","openApiOperationId":"peach.notes.handlers.list_borrower_notes","summary":"Get notes","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}},"schemaId":"schema_5718"}],"pointer":"/paths/~1people~1{personId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5718","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5718"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.list_borrower_notes"}],"panels":[]}]},"httpPath":"/people/{personId}/notes"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_borrower_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.create_borrower_note","name":"Create note","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1people~1{personId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/notes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/notes","href":"notes/peach.notes.handlers.create_borrower_note","openApiOperationId":"peach.notes.handlers.create_borrower_note","summary":"Create note","securityGroups":[{"oauth2":["note:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.create_borrower_note"}],"panels":[]}]},"httpPath":"/people/{personId}/notes"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_borrower_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.get_borrower_note","name":"Get note by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get note by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/notes/{noteId}","href":"notes/peach.notes.handlers.get_borrower_note","openApiOperationId":"peach.notes.handlers.get_borrower_note","summary":"Get note by ID","securityGroups":[{"oauth2":["note:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.get_borrower_note"}],"panels":[]}]},"httpPath":"/people/{personId}/notes/{noteId}"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_borrower_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.notes.handlers.update_borrower_note","name":"Update note","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["note:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"noteId","in":"path","schemaId":"components/schemas/newStatus","description":"The note identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"schemaId":"components/schemas/NoteRequest","pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/notes/{noteId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"noteId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["note:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/notes/{noteId}","href":"notes/peach.notes.handlers.update_borrower_note","openApiOperationId":"peach.notes.handlers.update_borrower_note","summary":"Update note","securityGroups":[{"oauth2":["note:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}},"schemaId":"schema_5719"}],"pointer":"/paths/~1people~1{personId}~1notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/peach.notes.handlers.update_borrower_note"}],"panels":[]}]},"httpPath":"/people/{personId}/notes/{noteId}"}],"content":{"contentType":"group","meta":{"name":"Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/interactions/{interactionId}/notes","summary":"Get notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.list_interaction_notes","deprecated":false},{"title":"/interactions/{interactionId}/notes","summary":"Create note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/peach.notes.handlers.create_interaction_note","deprecated":false},{"title":"/interactions/{interactionId}/notes/{noteId}","summary":"Get note by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.get_interaction_note","deprecated":false},{"title":"/interactions/{interactionId}/notes/{noteId}","summary":"Update note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notes/peach.notes.handlers.update_interaction_note","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/notes","summary":"Get notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.list_case_notes","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/notes","summary":"Create note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/peach.notes.handlers.create_case_note","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/notes/{noteId}","summary":"Get note by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.get_case_note","deprecated":false},{"title":"/people/{personId}/cases/{caseId}/notes/{noteId}","summary":"Update note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notes/peach.notes.handlers.update_case_note","deprecated":false},{"title":"/people/{personId}/interaction-notes","summary":"Get interaction notes for a person","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.list_borrower_interaction_notes","deprecated":false},{"title":"/people/{personId}/notes","summary":"Get notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.list_borrower_notes","deprecated":false},{"title":"/people/{personId}/notes","summary":"Create note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/peach.notes.handlers.create_borrower_note","deprecated":false},{"title":"/people/{personId}/notes/{noteId}","summary":"Get note by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/peach.notes.handlers.get_borrower_note","deprecated":false},{"title":"/people/{personId}/notes/{noteId}","summary":"Update note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notes/peach.notes.handlers.update_borrower_note","deprecated":false}]}]}]}]}},{"type":"group","label":"Workflows","link":"/api-docs/api-public/workflows","routeSlug":"/api-docs/api-public/workflows","items":[{"label":"Get case workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.get_case_workflow","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.get_case_workflow","metadata":{"seo":{"title":"Get case workflow","description":"Get case workflow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_case_workflow","name":"Get case workflow","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get case workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow:create","workflow:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow:create","workflow:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow","href":"workflows/peach.workflows.handlers.get_case_workflow","openApiOperationId":"peach.workflows.handlers.get_case_workflow","summary":"Get case workflow","securityGroups":[{"oauth2":["workflow:create","workflow:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5730"}},"schemaId":"schema_5730"}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5730","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5730"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/peach.workflows.handlers.get_case_workflow"}],"panels":[]}]},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow"},{"label":"Update workflow step status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_step","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_step","metadata":{"seo":{"title":"Update workflow step status","description":"Update workflow step status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.update_workflow_step","name":"Update workflow step status","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workflow step status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"workflowStepId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow step ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5731"}},"schemaId":"schema_5731","pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"workflowStepId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5731"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}","href":"workflows/peach.workflows.handlers.update_workflow_step","openApiOperationId":"peach.workflows.handlers.update_workflow_step","summary":"Update workflow step status","securityGroups":[{"oauth2":["workflow:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5731","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5731"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/peach.workflows.handlers.update_workflow_step"}],"panels":[]}]},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}"},{"label":"Update workflow workitem status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_workitem","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_workitem","metadata":{"seo":{"title":"Update workflow workitem status","description":"Update workflow workitem status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.update_workflow_workitem","name":"Update workflow workitem status","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}~1workitems~1{workflowWorkitemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workflow workitem status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"caseId","in":"path","schemaId":"schema_5625","description":"The case object unique identifier.","required":true},{"name":"workflowStepId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow step ID","required":true},{"name":"workflowWorkitemId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow work item ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}~1workitems~1{workflowWorkitemId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5732"}},"schemaId":"schema_5732","pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}~1workitems~1{workflowWorkitemId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"workflowStepId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowWorkitemId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5732"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}","href":"workflows/peach.workflows.handlers.update_workflow_workitem","openApiOperationId":"peach.workflows.handlers.update_workflow_workitem","summary":"Update workflow workitem status","securityGroups":[{"oauth2":["workflow:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5732","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5732"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1cases~1{caseId}~1workflow~1steps~1{workflowStepId}~1workitems~1{workflowWorkitemId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/peach.workflows.handlers.update_workflow_workitem"}],"panels":[]}]},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}"}],"content":{"contentType":"group","meta":{"name":"Workflows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflows","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow","summary":"Get case workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/peach.workflows.handlers.get_case_workflow","deprecated":false},{"title":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}","summary":"Update workflow step status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflows/peach.workflows.handlers.update_workflow_step","deprecated":false},{"title":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}","summary":"Update workflow workitem status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflows/peach.workflows.handlers.update_workflow_workitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Workflow Types","link":"/api-docs/api-public/workflow-types","routeSlug":"/api-docs/api-public/workflow-types","items":[{"label":"Get workflow step types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_types","metadata":{"seo":{"title":"Get workflow step types","description":"Get workflow step types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workflow_step_types","name":"Get workflow step types","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow step types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-step-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-step-types","href":"workflow-types/peach.workflows.handlers.get_workflow_step_types","openApiOperationId":"peach.workflows.handlers.get_workflow_step_types","summary":"Get workflow step types","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5733"}},"schemaId":"schema_5733"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5733","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5733"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workflow_step_types"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-step-types"},{"label":"Create workflow step type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_step_type","metadata":{"seo":{"title":"Create workflow step type","description":"Create workflow step type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.create_workflow_step_type","name":"Create workflow step type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create workflow step type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"schemaId":"components/schemas/WorkflowStepType","pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/workflow-step-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-step-types","href":"workflow-types/peach.workflows.handlers.create_workflow_step_type","openApiOperationId":"peach.workflows.handlers.create_workflow_step_type","summary":"Create workflow step type","securityGroups":[{"oauth2":["workflow.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowStepType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}},"schemaId":"schema_5734"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5734","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.create_workflow_step_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-step-types"},{"label":"Delete workflow step type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_step_type","metadata":{"seo":{"title":"Delete workflow step type","description":"Delete workflow step type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.delete_workflow_step_type","name":"Delete workflow step type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete workflow step type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowStepTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow step type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowStepTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","href":"workflow-types/peach.workflows.handlers.delete_workflow_step_type","openApiOperationId":"peach.workflows.handlers.delete_workflow_step_type","summary":"Delete workflow step type","securityGroups":[{"oauth2":["workflow.type:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.delete_workflow_step_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}"},{"label":"Get workflow step type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","metadata":{"seo":{"title":"Get workflow step type","description":"Get workflow step type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workflow_step_type_by_id","name":"Get workflow step type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow step type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowStepTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow step type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_5623","description":"Replace component IDs with corresponding objects"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowStepTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"expand","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","href":"workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","openApiOperationId":"peach.workflows.handlers.get_workflow_step_type_by_id","summary":"Get workflow step type","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}},"schemaId":"schema_5734"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5734","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}"},{"label":"Update workflow step type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_step_type","metadata":{"seo":{"title":"Update workflow step type","description":"Update workflow step type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.update_workflow_step_type","name":"Update workflow step type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workflow step type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowStepTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow step type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"schemaId":"components/schemas/WorkflowStepType","pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowStepTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","href":"workflow-types/peach.workflows.handlers.update_workflow_step_type","openApiOperationId":"peach.workflows.handlers.update_workflow_step_type","summary":"Update workflow step type","securityGroups":[{"oauth2":["workflow.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowStepType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowStepType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}},"schemaId":"schema_5734"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-step-types~1{workflowStepTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5734","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5734"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.update_workflow_step_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}"},{"label":"Get workflow types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_types","metadata":{"seo":{"title":"Get workflow types","description":"Get workflow types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workflow_types","name":"Get workflow types","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-types","href":"workflow-types/peach.workflows.handlers.get_workflow_types","openApiOperationId":"peach.workflows.handlers.get_workflow_types","summary":"Get workflow types","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5735"}},"schemaId":"schema_5735"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5735","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5735"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workflow_types"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types"},{"label":"Create workflow type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_type","metadata":{"seo":{"title":"Create workflow type","description":"Create workflow type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.create_workflow_type","name":"Create workflow type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create workflow type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"schemaId":"components/schemas/WorkflowType","pointer":"/paths/~1companies~1{companyId}~1workflow-types/post/requestBody","description":"The new workflow type"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/workflow-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-types","href":"workflow-types/peach.workflows.handlers.create_workflow_type","openApiOperationId":"peach.workflows.handlers.create_workflow_type","summary":"Create workflow type","securityGroups":[{"oauth2":["workflow.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}},"schemaId":"schema_5736"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5736","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.create_workflow_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types"},{"label":"Export workflow, step and work item types.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.export_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.export_workflow_types","metadata":{"seo":{"title":"Export workflow, step and work item types.","description":"Export workflow, step and work item types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.export_workflow_types","name":"Export workflow, step and work item types.","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1export/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export workflow, step and work item types.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1export/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_5737","description":"The output format"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1export/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/workflow-types/export","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"format","in":"query","schemaId":"schema_5737"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-types/export","href":"workflow-types/peach.workflows.handlers.export_workflow_types","openApiOperationId":"peach.workflows.handlers.export_workflow_types","summary":"Export workflow, step and work item types.","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/x-yaml"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5738"},"application/x-yaml":{"schemaId":"components/schemas/newStatus"}},"schemaId":"schema_5738"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1export/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5738","mediaTypes":["application/json","application/x-yaml"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5738"},"application/x-yaml":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.export_workflow_types"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types/export"},{"label":"Restore previously exported workflow, step and work item types.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.import_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.import_workflow_types","metadata":{"seo":{"title":"Restore previously exported workflow, step and work item types.","description":"Restore previously exported workflow, step and work item types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.import_workflow_types","name":"Restore previously exported workflow, step and work item types.","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore previously exported workflow, step and work item types.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/octet-stream","application/x-yaml"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5738"},"application/octet-stream":{"schemaId":"schema_5739"},"application/x-yaml":{"schemaId":"schema_5738"}},"schemaId":"schema_5738","pointer":"/paths/~1companies~1{companyId}~1workflow-types~1import/post/requestBody","description":"The data to import"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/workflow-types/import","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5738"},"application/octet-stream":{"schemaId":"schema_5739"},"application/x-yaml":{"schemaId":"schema_5738"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/workflow-types/import","href":"workflow-types/peach.workflows.handlers.import_workflow_types","openApiOperationId":"peach.workflows.handlers.import_workflow_types","summary":"Restore previously exported workflow, step and work item types.","securityGroups":[{"oauth2":["workflow.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5738","mediaTypes":["application/json","application/octet-stream","application/x-yaml"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5738"},"application/octet-stream":{"schemaId":"schema_5739"},"application/x-yaml":{"schemaId":"schema_5738"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"success"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1import/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.import_workflow_types"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types/import"},{"label":"Delete workflow type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_type","metadata":{"seo":{"title":"Delete workflow type","description":"Delete workflow type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.delete_workflow_type","name":"Delete workflow type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete workflow type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/workflow-types/{workflowTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/workflow-types/{workflowTypeId}","href":"workflow-types/peach.workflows.handlers.delete_workflow_type","openApiOperationId":"peach.workflows.handlers.delete_workflow_type","summary":"Delete workflow type","securityGroups":[{"oauth2":["workflow.type:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.delete_workflow_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}"},{"label":"Get workflow type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_type_by_id","metadata":{"seo":{"title":"Get workflow type by ID","description":"Get workflow type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workflow_type_by_id","name":"Get workflow type by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_5623","description":"Replace component IDs with corresponding objects"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-types/{workflowTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"expand","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-types/{workflowTypeId}","href":"workflow-types/peach.workflows.handlers.get_workflow_type_by_id","openApiOperationId":"peach.workflows.handlers.get_workflow_type_by_id","summary":"Get workflow type by ID","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}},"schemaId":"schema_5736"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5736","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workflow_type_by_id"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}"},{"label":"Update workflow type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_type","metadata":{"seo":{"title":"Update workflow type","description":"Update workflow type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.update_workflow_type","name":"Update workflow type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workflow type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The workflow type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"schemaId":"components/schemas/WorkflowType","pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/workflow-types/{workflowTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-types/{workflowTypeId}","href":"workflow-types/peach.workflows.handlers.update_workflow_type","openApiOperationId":"peach.workflows.handlers.update_workflow_type","summary":"Update workflow type","securityGroups":[{"oauth2":["workflow.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}},"schemaId":"schema_5736"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-types~1{workflowTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5736","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5736"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.update_workflow_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}"},{"label":"Get work item types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_types","metadata":{"seo":{"title":"Get work item types","description":"Get work item types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workitem_types","name":"Get work item types","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get work item types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-workitem-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-workitem-types","href":"workflow-types/peach.workflows.handlers.get_workitem_types","openApiOperationId":"peach.workflows.handlers.get_workitem_types","summary":"Get work item types","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5740"}},"schemaId":"schema_5740"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5740","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5740"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workitem_types"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-workitem-types"},{"label":"Create work item type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workitem_type","metadata":{"seo":{"title":"Create work item type","description":"Create work item type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.create_workitem_type","name":"Create work item type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create work item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"schemaId":"components/schemas/WorkflowWorkitemType","pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/workflow-workitem-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-workitem-types","href":"workflow-types/peach.workflows.handlers.create_workitem_type","openApiOperationId":"peach.workflows.handlers.create_workitem_type","summary":"Create work item type","securityGroups":[{"oauth2":["workflow.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowWorkitemType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}},"schemaId":"schema_5741"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5741","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.create_workitem_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-workitem-types"},{"label":"Delete work item type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workitem_type","metadata":{"seo":{"title":"Delete work item type","description":"Delete work item type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.delete_workitem_type","name":"Delete work item type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete work item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowWorkitemTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The work item type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowWorkitemTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","href":"workflow-types/peach.workflows.handlers.delete_workitem_type","openApiOperationId":"peach.workflows.handlers.delete_workitem_type","summary":"Delete work item type","securityGroups":[{"oauth2":["workflow.type:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.delete_workitem_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}"},{"label":"Get work item type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_type_by_id","metadata":{"seo":{"title":"Get work item type","description":"Get work item type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.get_workitem_type_by_id","name":"Get work item type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get work item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowWorkitemTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The work item type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowWorkitemTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","href":"workflow-types/peach.workflows.handlers.get_workitem_type_by_id","openApiOperationId":"peach.workflows.handlers.get_workitem_type_by_id","summary":"Get work item type","securityGroups":[{"oauth2":["workflow.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}},"schemaId":"schema_5741"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5741","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.get_workitem_type_by_id"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}"},{"label":"Update work item type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workitem_type","metadata":{"seo":{"title":"Update work item type","description":"Update work item type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.workflows.handlers.update_workitem_type","name":"Update work item type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update work item type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["workflow.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"workflowWorkitemTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The work item type ID","required":true}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"schemaId":"components/schemas/WorkflowWorkitemType","pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"workflowWorkitemTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["workflow.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","href":"workflow-types/peach.workflows.handlers.update_workitem_type","openApiOperationId":"peach.workflows.handlers.update_workitem_type","summary":"Update work item type","securityGroups":[{"oauth2":["workflow.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WorkflowWorkitemType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowWorkitemType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}},"schemaId":"schema_5741"}],"pointer":"/paths/~1companies~1{companyId}~1workflow-workitem-types~1{workflowWorkitemTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5741","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5741"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-types/peach.workflows.handlers.update_workitem_type"}],"panels":[]}]},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}"}],"content":{"contentType":"group","meta":{"name":"Workflow Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow Types","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/workflow-step-types","summary":"Get workflow step types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workflow_step_types","deprecated":false},{"title":"/companies/{companyId}/workflow-step-types","summary":"Create workflow step type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.create_workflow_step_type","deprecated":false},{"title":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","summary":"Delete workflow step type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.delete_workflow_step_type","deprecated":false},{"title":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","summary":"Get workflow step type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","deprecated":false},{"title":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","summary":"Update workflow step type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.update_workflow_step_type","deprecated":false},{"title":"/companies/{companyId}/workflow-types","summary":"Get workflow types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workflow_types","deprecated":false},{"title":"/companies/{companyId}/workflow-types","summary":"Create workflow type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.create_workflow_type","deprecated":false},{"title":"/companies/{companyId}/workflow-types/export","summary":"Export workflow, step and work item types.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.export_workflow_types","deprecated":false},{"title":"/companies/{companyId}/workflow-types/import","summary":"Restore previously exported workflow, step and work item types.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.import_workflow_types","deprecated":false},{"title":"/companies/{companyId}/workflow-types/{workflowTypeId}","summary":"Delete workflow type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.delete_workflow_type","deprecated":false},{"title":"/companies/{companyId}/workflow-types/{workflowTypeId}","summary":"Get workflow type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workflow_type_by_id","deprecated":false},{"title":"/companies/{companyId}/workflow-types/{workflowTypeId}","summary":"Update workflow type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.update_workflow_type","deprecated":false},{"title":"/companies/{companyId}/workflow-workitem-types","summary":"Get work item types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workitem_types","deprecated":false},{"title":"/companies/{companyId}/workflow-workitem-types","summary":"Create work item type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.create_workitem_type","deprecated":false},{"title":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","summary":"Delete work item type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.delete_workitem_type","deprecated":false},{"title":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","summary":"Get work item type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.get_workitem_type_by_id","deprecated":false},{"title":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","summary":"Update work item type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow-types/peach.workflows.handlers.update_workitem_type","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/api-docs/api-public/tasks","routeSlug":"/api-docs/api-public/tasks","items":[{"label":"Get information on Twilio task queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_all_queues","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_all_queues","metadata":{"seo":{"title":"Get information on Twilio task queues","description":"Get information on task queues such as friendly name and task statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.get_all_queues","name":"Get information on Twilio task queues","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-queues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get information on Twilio task queues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get information on task queues such as friendly name and task statistics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-queues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-queues","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-queues","href":"tasks/peach.twilio.taskrouter.handlers.get_all_queues","openApiOperationId":"peach.twilio.taskrouter.handlers.get_all_queues","summary":"Get information on Twilio task queues","securityGroups":[{"oauth2":["taskrouter.task.unterminated:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5742"}},"schemaId":"schema_5742"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-queues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5742","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5742"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.get_all_queues"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-queues"},{"label":"List Terminated Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","metadata":{"seo":{"title":"List Terminated Tasks","description":"List Terminated Tasks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_history.task_history_list","name":"List Terminated Tasks","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Terminated Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.terminated:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-terminated-tasks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.terminated:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-terminated-tasks","href":"tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","openApiOperationId":"peach.twilio.taskrouter.handlers_task_history.task_history_list","summary":"List Terminated Tasks","securityGroups":[{"oauth2":["taskrouter.task.terminated:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-terminated-tasks"},{"label":"Get Terminated Task by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","metadata":{"seo":{"title":"Get Terminated Task by ID","description":"Get Terminated Task by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_history.task_history_get","name":"Get Terminated Task by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Terminated Task by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.terminated:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"taskHistoryId","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the terminated task"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"taskHistoryId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.terminated:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}","href":"tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","openApiOperationId":"peach.twilio.taskrouter.handlers_task_history.task_history_get","summary":"Get Terminated Task by ID","securityGroups":[{"oauth2":["taskrouter.task.terminated:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}"},{"label":"Clone Terminated Task by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","metadata":{"seo":{"title":"Clone Terminated Task by ID","description":"Clone Terminated Task by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_history.task_history_clone","name":"Clone Terminated Task by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}~1clone/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone Terminated Task by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"taskHistoryId","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the terminated task"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}~1clone/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}/clone","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"taskHistoryId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}/clone","href":"tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","openApiOperationId":"peach.twilio.taskrouter.handlers_task_history.task_history_clone","summary":"Clone Terminated Task by ID","securityGroups":[{"oauth2":["taskrouter.task.unterminated:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-terminated-tasks~1{taskHistoryId}~1clone/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}/clone"},{"label":"Bulk Delete Unterminated Tasks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","metadata":{"seo":{"title":"Bulk Delete Unterminated Tasks","description":"Bulk delete unterminated tasks from Twilio API. (this proxy's Twilio'sTask API)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.delete_unterminated_tasks","name":"Bulk Delete Unterminated Tasks","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Delete Unterminated Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk delete unterminated tasks from Twilio API. (this proxy's Twilio's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An \"unterminated\" task is an \"active\" task—or any task which has yet to have its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task assignment status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See: https://www.twilio.com/docs/taskrouter/lifecycle-task-state"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:bulk.delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5743"}},"schemaId":"schema_5743","pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/twilio-unterminated-tasks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:bulk.delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5743"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-unterminated-tasks","href":"tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","openApiOperationId":"peach.twilio.taskrouter.handlers.delete_unterminated_tasks","summary":"Bulk Delete Unterminated Tasks","securityGroups":[{"oauth2":["taskrouter.task.unterminated:bulk.delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5743","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5743"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks"},{"label":"List Unterminated Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","metadata":{"seo":{"title":"List Unterminated Tasks","description":"Reads unterminated task from Twilio API. (This essentially proxies Twilio'sTask API)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.list_unterminated_tasks","name":"List Unterminated Tasks","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Unterminated Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reads unterminated task from Twilio API. (This essentially proxies Twilio's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that paging works differently on this endpoint in order for compatibility"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the Twilio API—but you can still use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousUrl"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An \"unterminated\" task is an \"active\" task—or any task which has yet to have its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task assignment status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See: https://www.twilio.com/docs/taskrouter/lifecycle-task-state"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_5744","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields to include in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reservation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include information on the task's current reservation in the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reservation"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"taskQueueSid","in":"query","schemaId":"components/schemas/newStatus","description":"The SID of the TaskQueue with the Tasks to read.\n"},{"name":"assignmentStatus","in":"query","schemaId":"schema_5745","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignment status of the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the assignment status cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"unterminated\" tasks are never "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—by definition tasks"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of that status are \"terminated\"."},"children":[]}]}]}]},{"name":"taskType","in":"query","schemaId":"schema_5746","description":"Only display tasks matching any these task types\n"},{"name":"caseType","in":"query","schemaId":"schema_5747","description":"Only display tasks with a case with a matching any of these case type\n"},{"name":"caseId","in":"query","schemaId":"schema_5632","description":"Only display tasks with a case ID which matches any of these case IDs\n"},{"name":"supercaseId","in":"query","schemaId":"schema_5632","description":"Only display tasks with a supercase ID which matches any of these supercase IDs\n"},{"name":"interactionId","in":"query","schemaId":"schema_5632","description":"Only display tasks with an interaction ID which matches any of these interaction IDs\n"},{"name":"unableToComplete","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only display tasks which were created by an agent clicking \"Unable to Complete\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", display only "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tasks."},"children":[]}]}]}]},{"name":"taskAttrMatchExpr","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Taskrouter expression to use for matching the task by task attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[1] https://www.twilio.com/docs/taskrouter/expression-syntax"},"children":[]}]}]}]},{"name":"hasCase","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Only display tasks which have a case associated with them.\n"},{"name":"hasCaseOwner","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Only display tasks which has a case with an owner when the task was published.\n\n(Note that this filters based on the data in the task object, which represents the state of the\ncase at the moment the task was published.)\n"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-unterminated-tasks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_5744","style":"form","explode":false},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"taskQueueSid","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"assignmentStatus","in":"query","required":false,"schemaId":"schema_5745","style":"form","explode":false},{"name":"taskType","in":"query","required":false,"schemaId":"schema_5746","style":"form","explode":false},{"name":"caseType","in":"query","required":false,"schemaId":"schema_5747","style":"form","explode":false},{"name":"caseId","in":"query","required":false,"schemaId":"schema_5632","style":"form","explode":false},{"name":"supercaseId","in":"query","required":false,"schemaId":"schema_5632","style":"form","explode":false},{"name":"interactionId","in":"query","required":false,"schemaId":"schema_5632","style":"form","explode":false},{"name":"unableToComplete","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"taskAttrMatchExpr","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"hasCase","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"hasCaseOwner","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-unterminated-tasks","href":"tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","openApiOperationId":"peach.twilio.taskrouter.handlers.list_unterminated_tasks","summary":"List Unterminated Tasks","securityGroups":[{"oauth2":["taskrouter.task.unterminated:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5748"}},"schemaId":"schema_5748"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5748","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5748"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks"},{"label":"Deletes Unterminated Task by SID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","metadata":{"seo":{"title":"Deletes Unterminated Task by SID","description":"Delete the unterminated task from Twilio API (this proxy's Twilio'sTask API)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.delete_unterminated_task","name":"Deletes Unterminated Task by SID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes Unterminated Task by SID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the unterminated task from Twilio API (this proxy's Twilio's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deleted task immediately has its assignment status transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This also generates the Twilio event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An \"unterminated\" task is an \"active\" task—or any task which has yet to have its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task assignment status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See: https://www.twilio.com/docs/taskrouter/lifecycle-task-state"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"taskSid","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the task"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"taskSid","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","href":"tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","openApiOperationId":"peach.twilio.taskrouter.handlers.delete_unterminated_task","summary":"Deletes Unterminated Task by SID","securityGroups":[{"oauth2":["taskrouter.task.unterminated:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}"},{"label":"Read Unterminated Task by SID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","metadata":{"seo":{"title":"Read Unterminated Task by SID","description":"Read's the specified unterminated task from Twilio API (this proxy's Twilio'sTask API)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.read_unterminated_task","name":"Read Unterminated Task by SID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Unterminated Task by SID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read's the specified unterminated task from Twilio API (this proxy's Twilio's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An \"unterminated\" task is an \"active\" task—or any task which has yet to have its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task assignment status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See: https://www.twilio.com/docs/taskrouter/lifecycle-task-state"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task.unterminated:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"taskSid","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the task"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"taskSid","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task.unterminated:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","href":"tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","openApiOperationId":"peach.twilio.taskrouter.handlers.read_unterminated_task","summary":"Read Unterminated Task by SID","securityGroups":[{"oauth2":["taskrouter.task.unterminated:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5749"}},"schemaId":"schema_5749"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5749"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}"},{"label":"Abandon Unterminated Task by SID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","metadata":{"seo":{"title":"Abandon Unterminated Task by SID","description":"Abandon an unterminated, accepted task. i.e., Mark the task as \"Unable to Complete\"and create a duplicate task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.abandon_accepted_task","name":"Abandon Unterminated Task by SID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}~1abandon/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abandon Unterminated Task by SID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abandon an unterminated, accepted task. i.e., Mark the task as \"Unable to Complete\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and create a duplicate task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An \"unterminated\" task is an \"active\" task—or any task which has yet to have its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task assignment status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See: https://www.twilio.com/docs/taskrouter/lifecycle-task-state"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task:receive"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"taskSid","in":"path","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the task"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}~1abandon/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}/abandon","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"taskSid","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task:receive"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}/abandon","href":"tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","openApiOperationId":"peach.twilio.taskrouter.handlers.abandon_accepted_task","summary":"Abandon Unterminated Task by SID","securityGroups":[{"oauth2":["taskrouter.task:receive"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"400","description":"Failed to abandon task"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-unterminated-tasks~1{taskSid}~1abandon/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}/abandon"},{"label":"List Taskrouter Workers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_workers.list_workers","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_workers.list_workers","metadata":{"seo":{"title":"List Taskrouter Workers","description":"List all Taskrouter Workers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_workers.list_workers","name":"List Taskrouter Workers","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1twilio-workers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Taskrouter Workers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all Taskrouter Workers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Twilio workers up to 10,000—i.e., there"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no paging. It may suffer from poor performance for large numbers of workers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1twilio-workers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_5750","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extra fields to include in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statsToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statsToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with statistical information about the given workers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"since the start of \"today\" (from the worker's company's configured timezone)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1companies~1{companyId}~1twilio-workers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/twilio-workers","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_5750","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/twilio-workers","href":"tasks/peach.twilio.taskrouter.handlers_workers.list_workers","openApiOperationId":"peach.twilio.taskrouter.handlers_workers.list_workers","summary":"List Taskrouter Workers","securityGroups":[{"oauth2":["employee:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardIssuerPut"}},"schemaId":"components/schemas/VirtualCardIssuerPut"}],"pointer":"/paths/~1companies~1{companyId}~1twilio-workers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualCardIssuerPut","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardIssuerPut"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers_workers.list_workers"}],"panels":[]}]},"httpPath":"/companies/{companyId}/twilio-workers"},{"label":"Get task availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","metadata":{"seo":{"title":"Get task availability","description":"Get task availability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.get_tasktype_availability","name":"Get task availability","isWebhook":false,"pointer":"/paths/~1twilio~1tasktype-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get task availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task:receive"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twilio/tasktype-availability","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task:receive"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/twilio/tasktype-availability","href":"tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","openApiOperationId":"peach.twilio.taskrouter.handlers.get_tasktype_availability","summary":"Get task availability","securityGroups":[{"oauth2":["taskrouter.task:receive"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5751"}},"schemaId":"schema_5751"}],"pointer":"/paths/~1twilio~1tasktype-availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5751","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5751"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability"}],"panels":[]}]},"httpPath":"/twilio/tasktype-availability"},{"label":"Update task type availability","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","metadata":{"seo":{"title":"Update task type availability","description":"Update task type availability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers.update_tasktype_availability","name":"Update task type availability","isWebhook":false,"pointer":"/paths/~1twilio~1tasktype-availability/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task type availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["taskrouter.task:receive"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5752"}},"schemaId":"schema_5752","pointer":"/paths/~1twilio~1tasktype-availability/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/twilio/tasktype-availability","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["taskrouter.task:receive"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5752"}},"responseCodes":["200"],"pointer":"/twilio/tasktype-availability","href":"tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","openApiOperationId":"peach.twilio.taskrouter.handlers.update_tasktype_availability","summary":"Update task type availability","securityGroups":[{"oauth2":["taskrouter.task:receive"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5752","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5752"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5751"}},"schemaId":"schema_5751"}],"pointer":"/paths/~1twilio~1tasktype-availability/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5751","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5751"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability"}],"panels":[]}]},"httpPath":"/twilio/tasktype-availability"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"Tasks are used to track work that needs to be done by agents in the CRM. Tasks\nare automatically assigned to agents based on configurable characteristics of\nthe agents and the tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/twilio-queues","summary":"Get information on Twilio task queues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.get_all_queues","deprecated":false},{"title":"/companies/{companyId}/twilio-terminated-tasks","summary":"List Terminated Tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","deprecated":false},{"title":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}","summary":"Get Terminated Task by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","deprecated":false},{"title":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}/clone","summary":"Clone Terminated Task by ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","deprecated":false},{"title":"/companies/{companyId}/twilio-unterminated-tasks","summary":"Bulk Delete Unterminated Tasks","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","deprecated":false},{"title":"/companies/{companyId}/twilio-unterminated-tasks","summary":"List Unterminated Tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","deprecated":false},{"title":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","summary":"Deletes Unterminated Task by SID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","deprecated":false},{"title":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","summary":"Read Unterminated Task by SID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","deprecated":false},{"title":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}/abandon","summary":"Abandon Unterminated Task by SID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","deprecated":false},{"title":"/companies/{companyId}/twilio-workers","summary":"List Taskrouter Workers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers_workers.list_workers","deprecated":false},{"title":"/twilio/tasktype-availability","summary":"Get task availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","deprecated":false},{"title":"/twilio/tasktype-availability","summary":"Update task type availability","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","deprecated":false}]}]}]}]}},{"type":"group","label":"Task-Worker Pairing Configs","link":"/api-docs/api-public/task-worker-pairing-configs","routeSlug":"/api-docs/api-public/task-worker-pairing-configs","items":[{"label":"List task-worker pairing configs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","metadata":{"seo":{"title":"List task-worker pairing configs","description":"List the task-worker pairing configs for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","name":"List task-worker pairing configs","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List task-worker pairing configs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the task-worker pairing configs for a company.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5753","description":"Which fields to sort by"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/task-worker-pairing-configs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5753"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/task-worker-pairing-configs","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","summary":"List task-worker pairing configs","securityGroups":[{"oauth2":["twpc:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfigPaging"}},"schemaId":"components/schemas/TaskWorkerPairingConfigPaging"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskWorkerPairingConfigPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfigPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs"},{"label":"Create task-worker pairing config\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","metadata":{"seo":{"title":"Create task-worker pairing config\n","description":"Create a new task-worker pairing config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","name":"Create task-worker pairing config\n","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create task-worker pairing config\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new task-worker pairing config."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes here will not take effect until synchronization is run. See:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync task-worker pairing configs to Twilio"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"schemaId":"components/schemas/TaskWorkerPairingConfig","pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/task-worker-pairing-configs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/task-worker-pairing-configs","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","summary":"Create task-worker pairing config\n","securityGroups":[{"oauth2":["twpc:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TaskWorkerPairingConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}},"schemaId":"schema_5754"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5754","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs"},{"label":"Sync task-worker pairing configs to Twilio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","metadata":{"seo":{"title":"Sync task-worker pairing configs to Twilio","description":"Perform synchronization of task-worker pairing config to Twilio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","name":"Sync task-worker pairing configs to Twilio","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync task-worker pairing configs to Twilio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform synchronization of task-worker pairing config to Twilio. \n\nAPI changes to task-worker pairing configs will have no effect until this synchronization is run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/task-worker-pairing-configs/sync","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/task-worker-pairing-configs/sync","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","summary":"Sync task-worker pairing configs to Twilio","securityGroups":[{"oauth2":["twpc:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/sync"},{"label":"Delete task-worker pairing config","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","metadata":{"seo":{"title":"Delete task-worker pairing config","description":"Delete a task-worker pairing config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","name":"Delete task-worker pairing config","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete task-worker pairing config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a task-worker pairing config."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes here will not take effect until synchronization is run. See:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync task-worker pairing configs to Twilio"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskWorkerPairingConfigId","in":"path","schemaId":"schema_5625","required":true},{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"taskWorkerPairingConfigId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","summary":"Delete task-worker pairing config","securityGroups":[{"oauth2":["twpc:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete ok"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}"},{"label":"Get task-worker pairing config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","metadata":{"seo":{"title":"Get task-worker pairing config","description":"Get task-worker pairing config"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","name":"Get task-worker pairing config","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get task-worker pairing config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskWorkerPairingConfigId","in":"path","schemaId":"schema_5625","required":true},{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"taskWorkerPairingConfigId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","summary":"Get task-worker pairing config","securityGroups":[{"oauth2":["twpc:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}},"schemaId":"schema_5754"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5754","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}"},{"label":"Update task-worker pairing config","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","metadata":{"seo":{"title":"Update task-worker pairing config","description":"Update a task-worker pairing config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","name":"Update task-worker pairing config","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task-worker pairing config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a task-worker pairing config."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes here will not take effect until synchronization is run. See:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync task-worker pairing configs to Twilio"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["twpc:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskWorkerPairingConfigId","in":"path","schemaId":"schema_5625","required":true},{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"schemaId":"components/schemas/TaskWorkerPairingConfig","pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"taskWorkerPairingConfigId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["twpc:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","href":"task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","openApiOperationId":"peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","summary":"Update task-worker pairing config","securityGroups":[{"oauth2":["twpc:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TaskWorkerPairingConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskWorkerPairingConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}},"schemaId":"schema_5754"}],"pointer":"/paths/~1companies~1{companyId}~1task-worker-pairing-configs~1{taskWorkerPairingConfigId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5754","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5754"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}"}],"content":{"contentType":"group","meta":{"name":"Task-Worker Pairing Configs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task-Worker Pairing Configs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task-Worker Pairing Configs are used to configure the behavior of tasks in the CRM. A TWPC"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is used to define the rules for how tasks are assigned to agents (i.e., workers)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to configure a TWPC you need to understand the contents of task and worker"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objects. See the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Unterminated Task"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_workers.list_workers"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Workers"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/task-worker-pairing-configs","summary":"List task-worker pairing configs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","deprecated":false},{"title":"/companies/{companyId}/task-worker-pairing-configs","summary":"Create task-worker pairing config\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","deprecated":false},{"title":"/companies/{companyId}/task-worker-pairing-configs/sync","summary":"Sync task-worker pairing configs to Twilio","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","deprecated":false},{"title":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","summary":"Delete task-worker pairing config","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","deprecated":false},{"title":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","summary":"Get task-worker pairing config","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","deprecated":false},{"title":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","summary":"Update task-worker pairing config","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Loans Management","content":null},{"type":"group","label":"Loans","link":"/api-docs/api-public/loans","routeSlug":"/api-docs/api-public/loans","items":[{"label":"Get loans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.loans.handlers.loans_get_by_company","routeSlug":"/api-docs/api-public/loans/peach.loans.handlers.loans_get_by_company","metadata":{"seo":{"title":"Get loans","description":"Get all loans associated with a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.handlers.loans_get_by_company","name":"Get loans","isWebhook":false,"pointer":"/paths/~1loans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all loans associated with a company.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:listall"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5755","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result fields that will be fetched:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch all fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch only the following fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lockStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newInterestTimestampStartedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idsOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"statuses","in":"query","schemaId":"schema_5756","description":"A comma separated list of loan statuses to filter by"},{"name":"managedByPeach","in":"query","schemaId":"schema_5757","description":"If passed, only returns loans with a loan type with \"managed by peach\" set to this value.\n"},{"name":"includeAdditionalBorrowers","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addtionalBorrowers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field containing information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about other borrowers related to this loan, e.g., cosigner, coborrowers, and applicants."},"children":[]}]}]}]},{"name":"loanTypeId","in":"query","schemaId":"schema_5694","description":"Use this to limit results to a specific lender product."},{"name":"labels","in":"query","schemaId":"schema_5632","description":"A comma separated list of loan labels to filter by"},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"updatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not updated at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"updatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not updated at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"originatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not originated at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"originatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not originated at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"activatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not activated at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"activatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not activated at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"sortBy","in":"query","schemaId":"schema_5758","description":"The data attributes by which to sort the results."},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"If passed, only returns loans with a due date equal to this value."}],"pointer":"/paths/~1loans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5755"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5756"},{"name":"managedByPeach","in":"query","schemaId":"schema_5757"},{"name":"includeAdditionalBorrowers","in":"query","required":false,"schemaId":"schema_5623"},{"name":"loanTypeId","in":"query","schemaId":"schema_5694"},{"name":"labels","in":"query","required":false,"schemaId":"schema_5632"},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"updatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"updatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"originatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"originatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"activatedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"activatedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5758"},{"name":"dueDate","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:listall"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/loans","href":"loans/peach.loans.handlers.loans_get_by_company","openApiOperationId":"peach.loans.handlers.loans_get_by_company","summary":"Get loans","securityGroups":[{"oauth2":["loan:listall"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5759"}},"schemaId":"schema_5759"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1loans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5759","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5759"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.loans.handlers.loans_get_by_company"}],"panels":[]}]},"httpPath":"/loans"},{"label":"Get borrower's loans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_get","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_get","metadata":{"seo":{"title":"Get borrower's loans","description":"Get borrower's loans"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loans_get","name":"Get borrower's loans","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrower's loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"status","in":"query","schemaId":"schema_5756"},{"name":"loanTypeId","in":"query","schemaId":"schema_5694","description":"Use this to limit results to a specific lender product."},{"name":"includeAdditionalBorrowers","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addtionalBorrowers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field containing information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about other borrowers related to this loan, e.g., cosigner, coborrowers, and applicants."},"children":[]}]}]}]},{"name":"chargeOffBalance","in":"query","schemaId":"schema_5760","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This filter is only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of the statuses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In other words, this filter will only be applied on loans with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans will be returned (honoring other filters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans with outstanding balance greater than zero will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zeroBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans with zero outstanding balance will be returned."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","required":false,"schemaId":"schema_5756"},{"name":"loanTypeId","in":"query","schemaId":"schema_5694"},{"name":"includeAdditionalBorrowers","in":"query","required":false,"schemaId":"schema_5623"},{"name":"chargeOffBalance","in":"query","required":false,"schemaId":"schema_5760"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/loans","href":"loans/peach.people.loans.handlers.loans_get","openApiOperationId":"peach.people.loans.handlers.loans_get","summary":"Get borrower's loans","securityGroups":[{"oauth2":["loan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoansPaging"}},"schemaId":"components/schemas/LoansPaging"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1people~1{personId}~1loans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LoansPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoansPaging"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loans_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans"},{"label":"Create loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_add","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_add","metadata":{"seo":{"title":"Create loan","description":"Add a new loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loans_add","name":"Create loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new loan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1people~1{personId}~1loans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLoan"}},"schemaId":"components/schemas/NewLoan","pointer":"/paths/~1people~1{personId}~1loans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewLoan"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans","href":"loans/peach.people.loans.handlers.loans_add","openApiOperationId":"peach.people.loans.handlers.loans_add","summary":"Create loan","securityGroups":[{"oauth2":["loan:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/NewLoan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewLoan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}},"schemaId":"schema_5761"}],"pointer":"/paths/~1people~1{personId}~1loans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loans_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans"},{"label":"Get loan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get","metadata":{"seo":{"title":"Get loan by ID","description":"Get loan by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_get","name":"Get loan by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeAdditionalBorrowers","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addtionalBorrowers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field containing information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about other borrowers related to this loan, e.g., cosigner, coborrowers, and applicants."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"includeAdditionalBorrowers","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}","href":"loans/peach.people.loans.handlers.loan_get","openApiOperationId":"peach.people.loans.handlers.loan_get","summary":"Get loan by ID","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}},"schemaId":"schema_5761"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}"},{"label":"Update loan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update","metadata":{"seo":{"title":"Update loan","description":"Update loan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_update","name":"Update loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."},{"name":"force","in":"query","schemaId":"schema_5623","description":"Override that enables the update of a borrower's address of a loan.\n"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5762"}},"schemaId":"schema_5762","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"},{"name":"force","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5762"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}","href":"loans/peach.people.loans.handlers.loan_update","openApiOperationId":"peach.people.loans.handlers.loan_update","summary":"Update loan","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5762","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5762"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}},"schemaId":"schema_5761"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}"},{"label":"Accelerate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate","metadata":{"seo":{"title":"Accelerate loan","description":"The accelerate endpoint will change the status of an active loan to accelerated,and trigger any acceleration-related logic and accounting treatment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_accelerate","name":"Accelerate loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1accelerate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accelerate loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accelerate endpoint will change the status of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and trigger any acceleration-related logic and accounting treatment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceleration is only valid for installment and line of credit loans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:accelerate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1accelerate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanAccelerate"}},"schemaId":"components/schemas/LoanAccelerate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1accelerate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/accelerate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:accelerate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanAccelerate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/accelerate","href":"loans/peach.people.loans.handlers.loan_accelerate","openApiOperationId":"peach.people.loans.handlers.loan_accelerate","summary":"Accelerate loan","securityGroups":[{"oauth2":["loan:accelerate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanAccelerate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanAccelerate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Accelerate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5763"}},"schemaId":"schema_5763"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1accelerate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_accelerate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/accelerate"},{"label":"Activate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_activate","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_activate","metadata":{"seo":{"title":"Activate loan","description":"Activate loan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_activate","name":"Activate loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1activate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1activate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1activate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanActivate"}},"schemaId":"components/schemas/LoanActivate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1activate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/activate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanActivate"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/activate","href":"loans/peach.people.loans.handlers.loan_activate","openApiOperationId":"peach.people.loans.handlers.loan_activate","summary":"Activate loan","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanActivate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanActivate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5764"}},"schemaId":"schema_5764"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5764","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5764"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_activate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/activate"},{"label":"Cancel loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_cancel","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_cancel","metadata":{"seo":{"title":"Cancel loan","description":"The cancel loan endpoint will change the status of a loan to canceled, andtrigger any cancellation-related logic, such as removing a loan from active monitoringand handling the accounting treatment for canceled loans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_cancel","name":"Cancel loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancel loan endpoint will change the status of a loan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trigger any cancellation-related logic, such as removing a loan from active monitoring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and handling the accounting treatment for canceled loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An installment loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to be canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line of credit loan can be canceled if it has no draws with active purchases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special permission is required to cancel "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The metro2 details may optionally be sent with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountStatusCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"what should be reported to credit agencies."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:cancel"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override that enables the cancellation of active loans not managed by Peach. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:cancel.force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forced cancellation should only be used for testing purposes."},"children":[]}]}]}]},{"name":"clearAllExternalIds","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will clear all related loan, draws (if LOC), purchases (if LOC), transactions, and dynamic fees external IDs. This will emit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalid.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event for all impacted objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is a max limit of 1000 external IDs that can be cleared synchronously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are more than 1000, the request will fail with a HTTP 408 status code. You should instead set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearAllExternalIds=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and call the individual endpoints to clear external IDs."},"children":[]}]}]}]},{"name":"sync","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Today, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only controls the clearing of external IDs when cancelling a loan when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearAllExternalIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Clears the external IDs of the loan, draws, purchases, transactions, and dynamic fees up to the max limit of 1000."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are more than 1000, the request will fail with a HTTP 408 status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - will clear all external IDs asynchronously. This is not yet supported."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCancel"}},"schemaId":"components/schemas/LoanCancel","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"force","in":"query","schemaId":"schema_5623"},{"name":"clearAllExternalIds","in":"query","schemaId":"schema_5623"},{"name":"sync","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:cancel"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanCancel"}},"responseCodes":["204","408"],"pointer":"/people/{personId}/loans/{loanId}/cancel","href":"loans/peach.people.loans.handlers.loan_cancel","openApiOperationId":"peach.people.loans.handlers.loan_cancel","summary":"Cancel loan","securityGroups":[{"oauth2":["loan:cancel"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanCancel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCancel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cancel"},{"label":"Charge-off loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off","metadata":{"seo":{"title":"Charge-off loan","description":"The charge-off endpoint will change the status of a loan to chargedOff, and trigger anycharge-off-related logic and accounting treatment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_charge_off","name":"Charge-off loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1charge-off/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge-off loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge-off endpoint will change the status of a loan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and trigger any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge-off-related logic and accounting treatment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status before being moved to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If an active loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is being charged off, this endpoint will handle moving the loan status to acceleration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before charging off. Charge-off is only valid for installment and line of credit loans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:chargeoff"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1charge-off/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChargeOff"}},"schemaId":"components/schemas/LoanChargeOff","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1charge-off/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/charge-off","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:chargeoff"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanChargeOff"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/charge-off","href":"loans/peach.people.loans.handlers.loan_charge_off","openApiOperationId":"peach.people.loans.handlers.loan_charge_off","summary":"Charge-off loan","securityGroups":[{"oauth2":["loan:chargeoff"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanChargeOff","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChargeOff"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Charge Off","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5765"}},"schemaId":"schema_5765"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1charge-off/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5765","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5765"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_charge_off"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/charge-off"},{"label":"Close loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_close","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_close","metadata":{"seo":{"title":"Close loan","description":"Closing a loan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_close","name":"Close loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1close/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Closing a loan"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For line of credit - Prevents new draws from being opened and closes existing draws to block new purchases."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For installment loan with multiple advances - Prevents new advances from being created and cancels existing scheduled advances."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops further credit extension while maintaining existing balances and payment obligations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After closing a line of credit, the loan and all its draws will automatically transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once all of the following conditions are met:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The line and all its draws have no outstanding balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no pending transactions on the line or any of its draws."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no pending, authorized, or blocking disputed purchases on the line or any draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no open bankruptcy cases associated with the line."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line of credit or any of its draws in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status cannot be reopened."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:close"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1close/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5766"}},"schemaId":"schema_5766","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1close/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/close","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:close"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5766"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/close","href":"loans/peach.people.loans.handlers.loan_close","openApiOperationId":"peach.people.loans.handlers.loan_close","summary":"Close loan","securityGroups":[{"oauth2":["loan:close"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5766","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5766"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1close/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_close"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/close"},{"label":"Get loan credit limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get_credit_limit","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get_credit_limit","metadata":{"seo":{"title":"Get loan credit limit","description":"Get loan credit limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_get_credit_limit","name":"Get loan credit limit","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan credit limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"effectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/credit-limit","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"effectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-limit","href":"loans/peach.people.loans.handlers.loan_get_credit_limit","openApiOperationId":"peach.people.loans.handlers.loan_get_credit_limit","summary":"Get loan credit limit","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5767"}},"schemaId":"schema_5767"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5767","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5767"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_get_credit_limit"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-limit"},{"label":"Update loan credit limit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update_credit_limit","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update_credit_limit","metadata":{"seo":{"title":"Update loan credit limit","description":"Update loan credit limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_update_credit_limit","name":"Update loan credit limit","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan credit limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditLimitProperties"}},"schemaId":"components/schemas/CreditLimitProperties","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/credit-limit","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditLimitProperties"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-limit","href":"loans/peach.people.loans.handlers.loan_update_credit_limit","openApiOperationId":"peach.people.loans.handlers.loan_update_credit_limit","summary":"Update loan credit limit","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CreditLimitProperties","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditLimitProperties"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5768"}},"schemaId":"schema_5768"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-limit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5768","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5768"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_update_credit_limit"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-limit"},{"label":"Freeze loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_freeze","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_freeze","metadata":{"seo":{"title":"Freeze loan","description":"Freeze loan will change the status of an active loan to frozen effective as of thecurrent date. The loan will remain in a frozen status until the Unfreeze endpoint iscalled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_freeze","name":"Freeze loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1freeze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Freeze loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze loan will change the status of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" effective as of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current date. The loan will remain in a frozen status until the Unfreeze endpoint is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"called."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:freeze"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1freeze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5769"}},"schemaId":"schema_5769","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1freeze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/freeze","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:freeze"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5769"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/freeze","href":"loans/peach.people.loans.handlers.loan_freeze","openApiOperationId":"peach.people.loans.handlers.loan_freeze","summary":"Freeze loan","securityGroups":[{"oauth2":["loan:freeze"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5769","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5769"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1freeze/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_freeze"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/freeze"},{"label":"Get loan lock status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status","metadata":{"seo":{"title":"Get loan lock status","description":"Get loan lock status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.get_lock_status","name":"Get loan lock status","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1lock-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan lock status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1lock-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/lock-status","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/lock-status","href":"loans/peach.people.loans.handlers.get_lock_status","openApiOperationId":"peach.people.loans.handlers.get_lock_status","summary":"Get loan lock status","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Succeeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5770"}},"schemaId":"schema_5770"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1lock-status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5770","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5770"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.get_lock_status"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/lock-status"},{"label":"Migrate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.loans.migration.handlers.loan_migrate","routeSlug":"/api-docs/api-public/loans/peach.loans.migration.handlers.loan_migrate","metadata":{"seo":{"title":"Migrate loan","description":"Migrate loan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.handlers.loan_migrate","name":"Migrate loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migrate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:migrate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migrate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migrate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/migrate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:migrate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","408"],"pointer":"/people/{personId}/loans/{loanId}/migrate","href":"loans/peach.loans.migration.handlers.loan_migrate","openApiOperationId":"peach.loans.migration.handlers.loan_migrate","summary":"Migrate loan","securityGroups":[{"oauth2":["loan:migrate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Loan migration started"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migrate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.loans.migration.handlers.loan_migrate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migrate"},{"label":"Refresh loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_refresh","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_refresh","metadata":{"seo":{"title":"Refresh loan","description":"In the case that a loan is out of sync, the refresh endpoint will make sure thatobligations, expected payments, and interest accrual is brought into sync."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_refresh","name":"Refresh loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case that a loan is out of sync, the refresh endpoint will make sure that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"obligations, expected payments, and interest accrual is brought into sync."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh loan is only valid for the statuses of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:refresh"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refresh/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/refresh","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:refresh"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/refresh","href":"loans/peach.people.loans.handlers.loan_refresh","openApiOperationId":"peach.people.loans.handlers.loan_refresh","summary":"Refresh loan","securityGroups":[{"oauth2":["loan:refresh"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refresh/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_refresh"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/refresh"},{"label":"Reimburse","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reimburse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reimburse","metadata":{"seo":{"title":"Reimburse","description":"The reimburse endpoint should be used when the lender owes money to a borrower on a given loan.The endpoint will execute a reimbursement according to the specified reimbursementAmount. If the reimbursementAmount is greater than the amount owed to the borrower, the system will not process the reimbursement and return an error. Funds are reimbursed to a specified payment instrument. The endpoint will update the ledger and create a new transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_reimburse","name":"Reimburse","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reimburse/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reimburse","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reimburse endpoint should be used when the lender owes money to a borrower on a given loan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint will execute a reimbursement according to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than the amount owed to the borrower, the system will not process the reimbursement and return an error. Funds are reimbursed to a specified payment instrument. The endpoint will update the ledger and create a new transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is installment, the loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to process reimbursement."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is line of credit, the loan can be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to process reimbursement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment method can be of any type (e.g. bank account, card, etc.)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Peach is processing payments (per company configuration), the payment method must be a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note for external reimbursements, the lender is responsible for transitioning the transaction status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:reimburse"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reimburse/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanReimburse"}},"schemaId":"components/schemas/LoanReimburse","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reimburse/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/reimburse","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:reimburse"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanReimburse"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/reimburse","href":"loans/peach.people.loans.handlers.loan_reimburse","openApiOperationId":"peach.people.loans.handlers.loan_reimburse","summary":"Reimburse","securityGroups":[{"oauth2":["loan:reimburse"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanReimburse","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanReimburse"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}},"schemaId":"schema_5771"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reimburse/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5771","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_reimburse"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/reimburse"},{"label":"Reopen a closed loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reopen","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reopen","metadata":{"seo":{"title":"Reopen a closed loan","description":"Reopen a closed line of credit. This will allow new draws to be added. By default, draws in paidOff status willnot be reopened, and a line of credit that has transitioned to paidOff status cannot be reopened. Set force totrue to also reopen the line and all of its draws when they are paidOff (e.g. for a post-closure balancecorrection). No special permission is required beyond loan:reopen."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_reopen","name":"Reopen a closed loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reopen/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reopen a closed loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reopen a closed line of credit. This will allow new draws to be added. By default, draws in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not be reopened, and a line of credit that has transitioned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status cannot be reopened. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to also reopen the line and all of its draws when they are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. for a post-closure balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"correction). No special permission is required beyond "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:reopen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:reopen"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reopen/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5772"}},"schemaId":"schema_5772","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reopen/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/reopen","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:reopen"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5772"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/reopen","href":"loans/peach.people.loans.handlers.loan_reopen","openApiOperationId":"peach.people.loans.handlers.loan_reopen","summary":"Reopen a closed loan","securityGroups":[{"oauth2":["loan:reopen"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5772","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5772"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reopen/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_reopen"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/reopen"},{"label":"Reverse accelerate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate_reverse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate_reverse","metadata":{"seo":{"title":"Reverse accelerate","description":"A loan must be in accelerated status to be reversed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_accelerate_reverse","name":"Reverse accelerate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-accelerate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse accelerate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to be reversed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reverse accelerate endpoint will reverse a loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, and roll back any acceleration-related"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic and accounting treatment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse acceleration triggers a replay of the loan starting from the day of acceleration as if the loan was in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status. This means if the acceleration occurred on day 90 of the loan, and the reverse acceleration is triggered on day"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100, the loan will be replayed as an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loan with interest accrual between days 90-100. If the reversal is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"triggered on day 90 (the same day of the acceleration), no additional interest is accrued. The result of a reverse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"acceleration is a loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerationDueWithin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOffDueWithin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configurations of the loan are still in force. So a loan could"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"possibly go back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status during the next day if the balance is not paid on the day a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reversal was made."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:accelerate.reverse"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-accelerate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"schemaId":"components/schemas/CaseId","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-accelerate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/reverse-accelerate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:accelerate.reverse"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseId"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/reverse-accelerate","href":"loans/peach.people.loans.handlers.loan_accelerate_reverse","openApiOperationId":"peach.people.loans.handlers.loan_accelerate_reverse","summary":"Reverse accelerate","securityGroups":[{"oauth2":["loan:accelerate.reverse"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseId","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Reverse Accelerate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5773"}},"schemaId":"schema_5773"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-accelerate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5773","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5773"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_accelerate_reverse"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/reverse-accelerate"},{"label":"Reverse charge-off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off_reverse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off_reverse","metadata":{"seo":{"title":"Reverse charge-off","description":"A loan must be in chargedOff status to be reversed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_charge_off_reverse","name":"Reverse charge-off","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-charge-off/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse charge-off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to be reversed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reverse charge-off endpoint will reverse a loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, and roll back any charge-off-related logic"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and accounting treatment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse charge-off triggers a replay of the loan starting from the day of charge off as if the loan was in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status. This means if the charge-off occurred on day 120 of the loan, and the reverse charge-off is triggered on day"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"130, the loan will be replayed as an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loan with interest accrual between days 120-130. If the reversal is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"triggered on day 120 (the same day of the charge-off), no additional interest is accrued. The result of a reverse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge-off is a loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOffDueWithin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configurations of the loan is still in force. So a loan could possibly go back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status during the next day if the balance is not paid on the day a reversal was made."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:chargeoff.reverse"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-charge-off/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"schemaId":"components/schemas/CaseId","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-charge-off/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/reverse-charge-off","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:chargeoff.reverse"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseId"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/reverse-charge-off","href":"loans/peach.people.loans.handlers.loan_charge_off_reverse","openApiOperationId":"peach.people.loans.handlers.loan_charge_off_reverse","summary":"Reverse charge-off","securityGroups":[{"oauth2":["loan:chargeoff.reverse"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseId","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Reverse Charge Off","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5774"}},"schemaId":"schema_5774"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1reverse-charge-off/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5774","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5774"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_charge_off_reverse"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/reverse-charge-off"},{"label":"Unfreeze loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_unfreeze","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_unfreeze","metadata":{"seo":{"title":"Unfreeze loan","description":"The Unfreeze endpoint will change the status of a frozen loan back to active, accelerated or chargedOff."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_unfreeze","name":"Unfreeze loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1unfreeze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unfreeze loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Unfreeze endpoint will change the status of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loan back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account was overdue before it was frozen, the system will use the earliest overdue due date (before the freeze date)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to count the number of days overdue and might accelerate or charge off the account (based on the loan type configurations) as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"part of the unfreeze process. After the unfreeze process is completed, you can reverse the chargedOff status and take"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional actions such as posting a payment to make the account current."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:unfreeze"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1unfreeze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanUnfreeze"}},"schemaId":"components/schemas/LoanUnfreeze","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1unfreeze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/unfreeze","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:unfreeze"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanUnfreeze"}},"responseCodes":["200","423"],"pointer":"/people/{personId}/loans/{loanId}/unfreeze","href":"loans/peach.people.loans.handlers.loan_unfreeze","openApiOperationId":"peach.people.loans.handlers.loan_unfreeze","summary":"Unfreeze loan","securityGroups":[{"oauth2":["loan:unfreeze"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanUnfreeze","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanUnfreeze"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}},"schemaId":"schema_5775"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1unfreeze/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}}},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loans/peach.people.loans.handlers.loan_unfreeze"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/unfreeze"}],"content":{"contentType":"group","meta":{"name":"Loans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrowers typically have loans. We support multiple loan types and each loan type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comes with its set of federal and state compliance rules. You can maintain different statuses of a loan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower can have multiple loans. A loan can belong to multiple people, but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one borrower can be defined as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A loan is always created using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" borrower identifier. Other people can be added as part of the loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All loan attributes can be updated as long as the loan is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object become read only and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Loan doesn't start accruing interest until it is activated. To activate the loan, call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate a loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On activation the loan can use the due dates and payments schedule from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the loan can be re-amortized using the activation date as the loan start date."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/loans","summary":"Get loans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/peach.loans.handlers.loans_get_by_company","deprecated":false},{"title":"/people/{personId}/loans","summary":"Get borrower's loans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/peach.people.loans.handlers.loans_get","deprecated":false},{"title":"/people/{personId}/loans","summary":"Create loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loans_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}","summary":"Get loan by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}","summary":"Update loan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/accelerate","summary":"Accelerate loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_accelerate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/activate","summary":"Activate loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_activate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/cancel","summary":"Cancel loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_cancel","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/charge-off","summary":"Charge-off loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_charge_off","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/close","summary":"Close loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_close","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/credit-limit","summary":"Get loan credit limit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_get_credit_limit","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/credit-limit","summary":"Update loan credit limit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_update_credit_limit","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/freeze","summary":"Freeze loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_freeze","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/lock-status","summary":"Get loan lock status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loans/peach.people.loans.handlers.get_lock_status","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migrate","summary":"Migrate loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.loans.migration.handlers.loan_migrate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/refresh","summary":"Refresh loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_refresh","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/reimburse","summary":"Reimburse","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_reimburse","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/reopen","summary":"Reopen a closed loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_reopen","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/reverse-accelerate","summary":"Reverse accelerate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_accelerate_reverse","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/reverse-charge-off","summary":"Reverse charge-off","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_charge_off_reverse","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/unfreeze","summary":"Unfreeze loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loans/peach.people.loans.handlers.loan_unfreeze","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment Advances","link":"/api-docs/api-public/installment-advances","routeSlug":"/api-docs/api-public/installment-advances","items":[{"label":"Get advances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","metadata":{"seo":{"title":"Get advances","description":"Returns an installment loan's advances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.installment_advances.handlers.get_loan_advances","name":"Get advances","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get advances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an installment loan's advances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.advance:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5777","description":"The status of the advances."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/advances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"status","in":"query","schemaId":"schema_5777"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.advance:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/advances","href":"installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","openApiOperationId":"peach.people.loans.installment_advances.handlers.get_loan_advances","summary":"Get advances","securityGroups":[{"oauth2":["loan.advance:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5778"}},"schemaId":"schema_5778"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5778","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5778"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/advances"},{"label":"Create advance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","metadata":{"seo":{"title":"Create advance","description":"Create advance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.installment_advances.handlers.create_loan_advance","name":"Create advance","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create advance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.advance:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5779"}},"schemaId":"schema_5779","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/advances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.advance:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5779"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/advances","href":"installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","openApiOperationId":"peach.people.loans.installment_advances.handlers.create_loan_advance","summary":"Create advance","securityGroups":[{"oauth2":["loan.advance:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5779","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5779"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}},"schemaId":"schema_5780"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5780","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/advances"},{"label":"Get advance by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","metadata":{"seo":{"title":"Get advance by ID","description":"Returns an installment loan advance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.installment_advances.handlers.get_loan_advance","name":"Get advance by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get advance by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an installment loan advance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.advance:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"advanceId","in":"path","schemaId":"schema_5625","description":"The advance identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/advances/{advanceId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"advanceId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.advance:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/advances/{advanceId}","href":"installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","openApiOperationId":"peach.people.loans.installment_advances.handlers.get_loan_advance","summary":"Get advance by ID","securityGroups":[{"oauth2":["loan.advance:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}},"schemaId":"schema_5780"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5780","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/advances/{advanceId}"},{"label":"Update advance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","metadata":{"seo":{"title":"Update advance","description":"Update advance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.installment_advances.handlers.update_loan_advance","name":"Update advance","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update advance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.advance:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"advanceId","in":"path","schemaId":"schema_5625","description":"The advance identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Advance"}},"schemaId":"components/schemas/Advance","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/advances/{advanceId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"advanceId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.advance:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Advance"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/advances/{advanceId}","href":"installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","openApiOperationId":"peach.people.loans.installment_advances.handlers.update_loan_advance","summary":"Update advance","securityGroups":[{"oauth2":["loan.advance:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Advance","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Advance"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}},"schemaId":"schema_5780"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1advances~1{advanceId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5780","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5780"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/advances/{advanceId}"}],"content":{"contentType":"group","meta":{"name":"Installment Advances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment Advances","showPageActions":true},{"nodeType":"markdoc","content":"This object represents an installment advance (also called loan proceeds or loan disbursements). Advances should be used for installment\nloans of type \"multiple advances\". Advances can be made on Loan objects only. To clarify, Advances cannot be made on Line of Credit\nobjects. Advances increase principal balance of a Loan. Each advance has a unique identifier."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/advances","summary":"Get advances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/advances","summary":"Create advance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/advances/{advanceId}","summary":"Get advance by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/advances/{advanceId}","summary":"Update advance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment Refunds","link":"/api-docs/api-public/installment-refunds","routeSlug":"/api-docs/api-public/installment-refunds","items":[{"label":"Get refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_get","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_get","metadata":{"seo":{"title":"Get refunds","description":"Returns a list of all prior refunds for the loan, as well as the remaining eligible refund amount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_refunds_get","name":"Get refunds","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get refunds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all prior refunds for the loan, as well as the remaining eligible refund amount.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.refund:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/refunds","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.refund:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/refunds","href":"installment-refunds/peach.people.loans.handlers.loan_refunds_get","openApiOperationId":"peach.people.loans.handlers.loan_refunds_get","summary":"Get refunds","securityGroups":[{"oauth2":["loan.refund:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Refunds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5781"}},"schemaId":"schema_5781"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5781","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5781"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-refunds/peach.people.loans.handlers.loan_refunds_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/refunds"},{"label":"Create refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_post","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_post","metadata":{"seo":{"title":"Create refund","description":"The refund endpoint will execute a full or partial refund according to the refundAmount specified.A full refund is equal to the amountFinancedAtOrigination. An atFaultParty must also be specified,in order to trigger the corresponding accounting entries related to billing for the refund."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_refunds_post","name":"Create refund","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund endpoint will execute a full or partial refund according to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full refund is equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinancedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atFaultParty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to trigger the corresponding accounting entries related to billing for the refund."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.refund:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefund"}},"schemaId":"components/schemas/LoanRefund","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/refunds","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.refund:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanRefund"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/refunds","href":"installment-refunds/peach.people.loans.handlers.loan_refunds_post","openApiOperationId":"peach.people.loans.handlers.loan_refunds_post","summary":"Create refund","securityGroups":[{"oauth2":["loan.refund:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanRefund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Refund","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5782"}},"schemaId":"schema_5782"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5782","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5782"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-refunds/peach.people.loans.handlers.loan_refunds_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/refunds"},{"label":"Create refund v2","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","metadata":{"seo":{"title":"Create refund v2","description":"The refund endpoint will execute a full or partial refund according to the refundAmount specified.The total of all refunds cannot exceed the amountFinanced (or principalAmount)  passed at origination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_refunds_v2_post","name":"Create refund v2","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds-v2/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create refund v2","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund endpoint will execute a full or partial refund according to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total of all refunds cannot exceed the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")  passed at origination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A refund is applied in the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system first depletes any non-due principal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount will be stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDetails.refundNonDuePrincipalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any refund amount is left to apply, the system will create a transaction of type service credit and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCreditType=refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This transaction will be applied on the loan using the \"payment waterfall\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount will be stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDetails.refundTransactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the system applies the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCreditType=refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if there is any remaining unapplied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund amount, it will be recorded as credit to the borrower (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or amount owed to borrower.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will replay the loan from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please consider the following before creating refunds:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to fully refund the loan including interest and fees, pass the following:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the activation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the amount financed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOriginationFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundLateFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOtherFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundMDR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundDownPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set these attributes depending on your policy."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to partially refund the loan with prorated interest and/or fees, set the following. Prorated interest means"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will lower the principal from the activation date and re-accrue interest."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the activation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals a partial refund amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOriginationFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundLateFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOtherFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set these values depending on your policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundMDR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set this attribute depending on your policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundDownPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To remind: this attribute can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for a full refund."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to partially refund the loan without prorating interest and/or fees prior the refund date, set the following:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals an effective date of the refund (or keep empty to indicate \"today\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals a partial refund amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOriginationFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundLateFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOtherFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundMDR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To remind: this attribute can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the activation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundDownPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To remind: this attribute can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for a full refund."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.refund:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds-v2/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefundV2"}},"schemaId":"components/schemas/LoanRefundV2","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds-v2/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/refunds-v2","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.refund:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanRefundV2"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/refunds-v2","href":"installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","openApiOperationId":"peach.people.loans.handlers.loan_refunds_v2_post","summary":"Create refund v2","securityGroups":[{"oauth2":["loan.refund:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanRefundV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefundV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Refund","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5783"}},"schemaId":"schema_5783"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds-v2/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5783","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5783"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/refunds-v2"},{"label":"Cancel refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","metadata":{"seo":{"title":"Cancel refund","description":"Cancel a refund."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_refunds_cancel","name":"Cancel refund","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds~1{loanRefundId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel a refund.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.refund:cancel"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"loanRefundId","in":"path","schemaId":"schema_5625","description":"The loan refund identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds~1{loanRefundId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefundCancel"}},"schemaId":"components/schemas/LoanRefundCancel","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds~1{loanRefundId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanRefundId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.refund:cancel"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanRefundCancel"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel","href":"installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","openApiOperationId":"peach.people.loans.handlers.loan_refunds_cancel","summary":"Cancel refund","securityGroups":[{"oauth2":["loan.refund:cancel"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanRefundCancel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanRefundCancel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Refund","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5782"}},"schemaId":"schema_5782"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1refunds~1{loanRefundId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5782","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5782"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Installment Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment Refunds","showPageActions":true},{"nodeType":"markdoc","content":"This object represents refunds. Various situations require full or partial refunds of a loan. Depending on the refund\namount and whether the borrower has made payments, a refund may also trigger a reimbursement to the borrower."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/refunds","summary":"Get refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-refunds/peach.people.loans.handlers.loan_refunds_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/refunds","summary":"Create refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-refunds/peach.people.loans.handlers.loan_refunds_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/refunds-v2","summary":"Create refund v2","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel","summary":"Cancel refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","deprecated":false}]}]}]}]}},{"type":"group","label":"Line of Credit Draws","link":"/api-docs/api-public/line-of-credit-draws","routeSlug":"/api-docs/api-public/line-of-credit-draws","items":[{"label":"Preview draw amortization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","metadata":{"seo":{"title":"Preview draw amortization","description":"This endpoint is used for previewing draw amortization. The draw must have non-due principal to be amortized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.preview_draw_amortize","name":"Preview draw amortization","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1amortize-preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview draw amortization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for previewing draw amortization. The draw must have non-due principal to be amortized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is configured to accrue interest as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accrualMethod=compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"known limitation to the draw amortization calculation logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw amortization calculation will be done using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method and not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure that the system calculates interest accurately, amortized draws should NOT include any fees."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:amortize"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1amortize-preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5784"}},"schemaId":"schema_5784","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1amortize-preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/amortize-preview","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:amortize"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5784"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/amortize-preview","href":"line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","openApiOperationId":"peach.people.loans.draws.handlers.preview_draw_amortize","summary":"Preview draw amortization","securityGroups":[{"oauth2":["draw:amortize"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5784","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5784"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5785"}},"schemaId":"schema_5785"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1amortize-preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5785","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5785"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/amortize-preview"},{"label":"Get draws","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","metadata":{"seo":{"title":"Get draws","description":"Get draws"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.loan_draws_get","name":"Get draws","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draws","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"statuses","in":"query","schemaId":"schema_5756","description":"A comma separated list of loan statuses to filter by"},{"name":"isClosed","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for draws with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isClosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]}]}]}]},{"name":"isAmortized","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Filter for amortized or non-amortized draws"},{"name":"startedBefore","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Filter for draws started before a date"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"statuses","in":"query","required":false,"schemaId":"schema_5756"},{"name":"isClosed","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"isAmortized","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"startedBefore","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws","href":"line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","openApiOperationId":"peach.people.loans.draws.handlers.loan_draws_get","summary":"Get draws","securityGroups":[{"oauth2":["draw:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DrawsPaging"}},"schemaId":"components/schemas/DrawsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DrawsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DrawsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws"},{"label":"Create draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","metadata":{"seo":{"title":"Create draw","description":"Create draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.loan_draws_post","name":"Create draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Draw"}},"schemaId":"components/schemas/Draw","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Draw"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws","href":"line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","openApiOperationId":"peach.people.loans.draws.handlers.loan_draws_post","summary":"Create draw","securityGroups":[{"oauth2":["draw:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Draw","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Draw"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}},"schemaId":"schema_5786"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5786","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws"},{"label":"Get draw by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","metadata":{"seo":{"title":"Get draw by ID","description":"Get draw by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.loan_draw_get","name":"Get draw by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}","href":"line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","openApiOperationId":"peach.people.loans.draws.handlers.loan_draw_get","summary":"Get draw by ID","securityGroups":[{"oauth2":["draw:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}},"schemaId":"schema_5786"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5786","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}"},{"label":"Update draw","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","metadata":{"seo":{"title":"Update draw","description":"Update draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_update","name":"Update draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."},{"name":"force","in":"query","schemaId":"schema_5623","description":"Override that enables the update of a borrower's address of a loan.\n"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5787"}},"schemaId":"schema_5787","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"},{"name":"force","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5787"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","openApiOperationId":"peach.people.loans.draws.handlers.draw_update","summary":"Update draw","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5787","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5787"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}},"schemaId":"schema_5786"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5786","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}"},{"label":"Activate draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","metadata":{"seo":{"title":"Activate draw","description":"Activate draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_activate","name":"Activate draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:activate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1activate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/activate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:activate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/activate","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","openApiOperationId":"peach.people.loans.draws.handlers.draw_activate","summary":"Activate draw","securityGroups":[{"oauth2":["draw:activate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5788"}},"schemaId":"schema_5788"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5788","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5788"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/activate"},{"label":"Amortize draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","metadata":{"seo":{"title":"Amortize draw","description":"This endpoint is used for draw amortization. The draw must have non-due principal to be reamortized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.loan_draw_amortize","name":"Amortize draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1amortize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Amortize draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for draw amortization. The draw must have non-due principal to be reamortized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is configured to accrue interest as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accrualMethod=compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"known limitation to the draw amortization calculation logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw amortization calculation will be done using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method and not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure that the system calculates interest accurately, amortized draws should NOT include any fees."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:amortize"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1amortize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5789"}},"schemaId":"schema_5789","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1amortize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/amortize","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:amortize"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5789"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/amortize","href":"line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","openApiOperationId":"peach.people.loans.draws.handlers.loan_draw_amortize","summary":"Amortize draw","securityGroups":[{"oauth2":["draw:amortize"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5789","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5789"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5785"}},"schemaId":"schema_5785"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1amortize/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5785","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5785"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/amortize"},{"label":"Cancel draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","metadata":{"seo":{"title":"Cancel draw","description":"The cancel loan endpoint will change the status of a draw to canceled, andtrigger any cancellation-related logic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_cancel","name":"Cancel draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancel loan endpoint will change the status of a draw to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trigger any cancellation-related logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An active draw can be canceled if it has no active purchases."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw:cancel"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override that enables the cancellation of active loans not managed by Peach. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:cancel.force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forced cancellation should only be used for testing purposes."},"children":[]}]}]}]},{"name":"clearAllExternalIds","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will clear all related loan, draws (if LOC), purchases (if LOC), transactions, and dynamic fees external IDs. This will emit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalid.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event for all impacted objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is a max limit of 1000 external IDs that can be cleared synchronously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are more than 1000, the request will fail with a HTTP 408 status code. You should instead set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearAllExternalIds=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and call the individual endpoints to clear external IDs."},"children":[]}]}]}]},{"name":"sync","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Today, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only controls the clearing of external IDs when cancelling a loan when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearAllExternalIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Clears the external IDs of the loan, draws, purchases, transactions, and dynamic fees up to the max limit of 1000."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are more than 1000, the request will fail with a HTTP 408 status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - will clear all external IDs asynchronously. This is not yet supported."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5790"}},"schemaId":"schema_5790","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"force","in":"query","schemaId":"schema_5623"},{"name":"clearAllExternalIds","in":"query","schemaId":"schema_5623"},{"name":"sync","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw:cancel"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5790"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/cancel","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","openApiOperationId":"peach.people.loans.draws.handlers.draw_cancel","summary":"Cancel draw","securityGroups":[{"oauth2":["draw:cancel"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1cancel/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/cancel"},{"label":"Close draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","metadata":{"seo":{"title":"Close draw","description":"Closing a draw means that the draw can no longer accept new purchases. The draw will automatically transitionto paidOff status once all of the following conditions are met:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_close","name":"Close draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1close/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Closing a draw means that the draw can no longer accept new purchases. The draw will automatically transition"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status once all of the following conditions are met:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw has no outstanding balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no pending transactions on the draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no pending, authorized, or blocking disputed purchases on the draw."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A draw in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status cannot be reopened."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:close"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1close/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5791"}},"schemaId":"schema_5791","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1close/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/close","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:close"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5791"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/close","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","openApiOperationId":"peach.people.loans.draws.handlers.draw_close","summary":"Close draw","securityGroups":[{"oauth2":["loan:close"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5791","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5791"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1close/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/close"},{"label":"Get draw credit limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","metadata":{"seo":{"title":"Get draw credit limit","description":"Get draw credit limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_get_credit_limit","name":"Get draw credit limit","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw credit limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"effectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"effectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","openApiOperationId":"peach.people.loans.draws.handlers.draw_get_credit_limit","summary":"Get draw credit limit","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5792"}},"schemaId":"schema_5792"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5792","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5792"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit"},{"label":"Update draw credit limit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","metadata":{"seo":{"title":"Update draw credit limit","description":"Update draw credit limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_update_credit_limit","name":"Update draw credit limit","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw credit limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5793"}},"schemaId":"schema_5793","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5793"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","openApiOperationId":"peach.people.loans.draws.handlers.draw_update_credit_limit","summary":"Update draw credit limit","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5793","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5793"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}},"schemaId":"schema_5786"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1credit-limit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5786","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5786"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit"},{"label":"Update draw fees","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","metadata":{"seo":{"title":"Update draw fees","description":"Allows lenders to add or remove dynamic fees from a draw going forward. This does not affect balances or fees in the past."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","name":"Update draw fees","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1dynamic-fees/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw fees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows lenders to add or remove dynamic fees from a draw going forward. This does not affect balances or fees in the past.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1dynamic-fees/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtOriginationDynamicFees"}},"schemaId":"components/schemas/AtOriginationDynamicFees","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1dynamic-fees/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/dynamic-fees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtOriginationDynamicFees"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/dynamic-fees","href":"line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","openApiOperationId":"peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","summary":"Update draw fees","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AtOriginationDynamicFees","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtOriginationDynamicFees"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5794"}},"schemaId":"schema_5794"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1dynamic-fees/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5794","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5794"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/dynamic-fees"},{"label":"Update draw min pay calculation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","metadata":{"seo":{"title":"Update draw min pay calculation","description":"Update draw min pay calculation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_min_payment_calculation_post","name":"Update draw min pay calculation","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1min-payment-calculation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw min pay calculation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1min-payment-calculation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5795"}},"schemaId":"schema_5795","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1min-payment-calculation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/min-payment-calculation","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5795"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/min-payment-calculation","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","openApiOperationId":"peach.people.loans.draws.handlers.draw_min_payment_calculation_post","summary":"Update draw min pay calculation","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5795","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5795"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5795"}},"schemaId":"schema_5795"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1min-payment-calculation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5795","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5795"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/min-payment-calculation"},{"label":"Reopen draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","metadata":{"seo":{"title":"Reopen draw","description":"Reopen a closed draw. This will allow new purchases to be added to the draw. By default, a draw in paidOffstatus cannot be reopened. Set force to true to reopen a paidOff draw (e.g. for a post-closure balancecorrection); its parent line of credit is also reopened if needed, but sibling draws are left untouched. Nospecial permission is required beyond loan:reopen."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.draws.handlers.draw_reopen","name":"Reopen draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1reopen/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reopen draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reopen a closed draw. This will allow new purchases to be added to the draw. By default, a draw in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status cannot be reopened. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reopen a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" draw (e.g. for a post-closure balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"correction); its parent line of credit is also reopened if needed, but sibling draws are left untouched. No"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special permission is required beyond "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:reopen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:reopen"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1reopen/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5796"}},"schemaId":"schema_5796","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1reopen/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/reopen","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:reopen"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5796"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/reopen","href":"line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","openApiOperationId":"peach.people.loans.draws.handlers.draw_reopen","summary":"Reopen draw","securityGroups":[{"oauth2":["loan:reopen"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5796","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5796"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1reopen/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/reopen"}],"content":{"contentType":"group","meta":{"name":"Line of Credit Draws"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Line of Credit Draws","showPageActions":true},{"nodeType":"markdoc","content":"This object represents a draw. Draws can be made on Line of Credit loans only. Draws can be amortized\nor non-amortized. If amortized, the draw will be amortized over the selected number of periods and aligned to the Line of\nCredit due dates. If non-amortized, the draw is due on a due date following the current period statement creation.\nA draw can have different interest and promo rates from the Line of Credit. Each draw has a unique identifier, similar to a loan."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/amortize-preview","summary":"Preview draw amortization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws","summary":"Get draws","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws","summary":"Create draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}","summary":"Get draw by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}","summary":"Update draw","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/activate","summary":"Activate draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/amortize","summary":"Amortize draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/cancel","summary":"Cancel draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/close","summary":"Close draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","summary":"Get draw credit limit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","summary":"Update draw credit limit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/dynamic-fees","summary":"Update draw fees","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/min-payment-calculation","summary":"Update draw min pay calculation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/reopen","summary":"Reopen draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","deprecated":false}]}]}]}]}},{"type":"group","label":"Line of Credit Purchases","link":"/api-docs/api-public/line-of-credit-purchases","routeSlug":"/api-docs/api-public/line-of-credit-purchases","items":[{"label":"Get line of credit purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","metadata":{"seo":{"title":"Get line of credit purchase disputes","description":"Get line of credit purchase disputes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","name":"Get line of credit purchase disputes","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1disputes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get line of credit purchase disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1disputes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results to disputes whose underlying purchase is linked to one of these cards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts Peach "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs and external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs. Unresolvable IDs are ignored."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/disputes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/disputes","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","summary":"Get line of credit purchase disputes","securityGroups":[{"oauth2":["purchase.dispute:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}},"schemaId":"schema_5797"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/disputes"},{"label":"Get draw purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","metadata":{"seo":{"title":"Get draw purchase disputes","description":"Get draw purchase disputes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","name":"Get draw purchase disputes","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1disputes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw purchase disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1disputes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results to disputes whose underlying purchase is linked to one of these cards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts Peach "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs and external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs. Unresolvable IDs are ignored."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/disputes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/disputes","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","summary":"Get draw purchase disputes","securityGroups":[{"oauth2":["purchase.dispute:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}},"schemaId":"schema_5797"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/disputes"},{"label":"Get draw purchases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","metadata":{"seo":{"title":"Get draw purchases","description":"Get draw purchases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.draw_purchases_get","name":"Get draw purchases","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw purchases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_5798","description":"The statuses of the purchases to fetch"},{"name":"statuses","in":"query","schemaId":"schema_5799","description":"The statuses of the purchases to fetch"},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter purchases by one or more card identifiers. Each value can be a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unresolvable ids are silently ignored; if no ids resolve the result"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set is empty. Omit the param for no filtering."},"children":[]}]}]}]},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromEffectiveAt"},"children":[]}]}]}]},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toEffectiveAt"},"children":[]}]}]}]},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCreatedAt"},"children":[]}]}]}]},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCreatedAt"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5800","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"types","in":"query","required":false,"schemaId":"schema_5798"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5799"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5800"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","openApiOperationId":"peach.people.loans.purchases.handlers.draw_purchases_get","summary":"Get draw purchases","securityGroups":[{"oauth2":["draw.purchase:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Purchases","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5801"}},"schemaId":"schema_5801"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5801","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5801"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases"},{"label":"Create purchase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","metadata":{"seo":{"title":"Create purchase","description":"Create purchase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.draw_purchases_create","name":"Create purchase","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create purchase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases, even if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchase amount pushes the line or draw above the credit limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The line or draw "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isClosed=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceOverLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceIfClosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"name":"forceOverLimit","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases even if the purchase amount pushes the line or draw above the credit limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, this parameter is ignored."},"children":[]}]}]}]},{"name":"forceIfClosed","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases even if the line or draw "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isClosed=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, this parameter is ignored."},"children":[]}]}]}]},{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5802"}},"schemaId":"schema_5802","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"force","in":"query","schemaId":"schema_5623"},{"name":"forceOverLimit","in":"query","schemaId":"schema_5623"},{"name":"forceIfClosed","in":"query","schemaId":"schema_5623"},{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5802"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","openApiOperationId":"peach.people.loans.purchases.handlers.draw_purchases_create","summary":"Create purchase","securityGroups":[{"oauth2":["draw.purchase:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5802","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5802"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"}},"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreateOrUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases"},{"label":"Get draw purchases timeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","metadata":{"seo":{"title":"Get draw purchases timeline","description":"Get draw purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if effectiveAt and authorizedAt are provided in that order, Peach will"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.draw_purchases_timeline_get","name":"Get draw purchases timeline","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases-timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw purchases timeline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get draw purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided in that order, Peach will"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"check first for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. If it exists, insert into timeline using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not exist, check for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If it exists, insert into timeline using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if neither exist, insert purchase into timeline using createdAt."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases-timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_5798","description":"The statuses of the purchases to fetch"},{"name":"statuses","in":"query","schemaId":"schema_5799","description":"The statuses of the purchases to fetch"},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter purchases by one or more card identifiers. Each value can be a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unresolvable ids are silently ignored; if no ids resolve the result"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set is empty. Omit the param for no filtering."},"children":[]}]}]}]},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromEffectiveAt"},"children":[]}]}]}]},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toEffectiveAt"},"children":[]}]}]}]},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCreatedAt"},"children":[]}]}]}]},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCreatedAt"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"timelineOrdering","in":"query","schemaId":"schema_5803","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters used to generate a timeline of purchases. Purchases will be inserted into the timeline based on the parameters provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are available for sorting. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used if any purchases would not be inserted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into the timeline based on the attributes provided. The full timeline will be sorted either ASC ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or DESC ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). It cannot be sorted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on individual attributes. e.g. [-effectiveAt, +authorizedAt, -createdAt] is not a valid input."},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_5804","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the purchase timeline returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - oldest to newest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - newest to oldest"},"children":[]}]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases-timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases-timeline","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"types","in":"query","required":false,"schemaId":"schema_5798"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5799"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"timelineOrdering","in":"query","required":false,"schemaId":"schema_5803"},{"name":"sortOrder","in":"query","required":false,"schemaId":"schema_5804"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases-timeline","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","openApiOperationId":"peach.people.loans.purchases.handlers.draw_purchases_timeline_get","summary":"Get draw purchases timeline","securityGroups":[{"oauth2":["draw.purchase:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Purchases","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5801"}},"schemaId":"schema_5801"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases-timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5801","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5801"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases-timeline"},{"label":"Get purchase by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","metadata":{"seo":{"title":"Get purchase by ID","description":"Get purchase by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.draw_purchase_get_one","name":"Get purchase by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get purchase by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","openApiOperationId":"peach.people.loans.purchases.handlers.draw_purchase_get_one","summary":"Get purchase by ID","securityGroups":[{"oauth2":["draw.purchase:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5805"}},"schemaId":"schema_5805"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5805","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5805"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}"},{"label":"Update purchase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","metadata":{"seo":{"title":"Update purchase","description":"Update purchase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.draw_purchase_update","name":"Update purchase","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update purchase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases, even if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchase amount pushes the line or draw above the credit limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The line or draw "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isClosed=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceOverLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceIfClosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"name":"forceOverLimit","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases even if the purchase amount pushes the line or draw above the credit limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, this parameter is ignored."},"children":[]}]}]}]},{"name":"forceIfClosed","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows creating or updating purchases even if the line or draw "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isClosed=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.purchase:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, this parameter is ignored."},"children":[]}]}]}]},{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseUpdateInternal"}},"schemaId":"components/schemas/PurchaseUpdateInternal","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"force","in":"query","schemaId":"schema_5623"},{"name":"forceOverLimit","in":"query","schemaId":"schema_5623"},{"name":"forceIfClosed","in":"query","schemaId":"schema_5623"},{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseUpdateInternal"}},"responseCodes":["200","408","423"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","openApiOperationId":"peach.people.loans.purchases.handlers.draw_purchase_update","summary":"Update purchase","securityGroups":[{"oauth2":["draw.purchase:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PurchaseUpdateInternal","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseUpdateInternal"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"}},"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"},{"code":"408","description":"Request Timeout"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreateOrUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreateOrUpdateResponse"}}},{"code":"408"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}"},{"label":"Get purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","metadata":{"seo":{"title":"Get purchase disputes","description":"Get purchase disputes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","name":"Get purchase disputes","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get purchase disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","summary":"Get purchase disputes","securityGroups":[{"oauth2":["purchase.dispute:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}},"schemaId":"schema_5797"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5797"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes"},{"label":"Create purchase dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","metadata":{"seo":{"title":"Create purchase dispute","description":"Creates a new purchase dispute. Purchases in authorized status may not be disputed. They must firstbe written to the ledger by changing the status of the purchase or creating a new purchase object inpending or settled status. Once one of those steps have been taken, the purchase may be disputed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_dispute_create","name":"Create purchase dispute","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create purchase dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new purchase dispute. Purchases in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status may not be disputed. They must first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be written to the ledger by changing the status of the purchase or creating a new purchase object in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending or settled status. Once one of those steps have been taken, the purchase may be disputed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5806"}},"schemaId":"schema_5806","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5806"}},"responseCodes":["200","423"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_dispute_create","summary":"Create purchase dispute","securityGroups":[{"oauth2":["purchase.dispute:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5806","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5806"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}},"schemaId":"schema_5807"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}}},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes"},{"label":"Get purchase dispute by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","metadata":{"seo":{"title":"Get purchase dispute by ID","description":"Get purchase dispute by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_dispute_get","name":"Get purchase dispute by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get purchase dispute by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true},{"name":"purchaseDisputeId","in":"path","schemaId":"schema_5625","description":"The ID of the purchase dispute","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseDisputeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_dispute_get","summary":"Get purchase dispute by ID","securityGroups":[{"oauth2":["purchase.dispute:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}},"schemaId":"schema_5807"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}"},{"label":"Update purchase dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","metadata":{"seo":{"title":"Update purchase dispute","description":"Update purchase dispute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.purchase_disputes.handlers.purchase_dispute_update","name":"Update purchase dispute","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update purchase dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["purchase.dispute:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"purchaseId","in":"path","schemaId":"schema_5625","description":"The purchase identifier.","required":true},{"name":"purchaseDisputeId","in":"path","schemaId":"schema_5625","description":"The ID of the purchase dispute","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseDispute"}},"schemaId":"components/schemas/PurchaseDispute","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"purchaseDisputeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["purchase.dispute:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseDispute"}},"responseCodes":["200","408","423"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","href":"line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","openApiOperationId":"peach.loans.purchase_disputes.handlers.purchase_dispute_update","summary":"Update purchase dispute","securityGroups":[{"oauth2":["purchase.dispute:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PurchaseDispute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseDispute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}},"schemaId":"schema_5807"},{"code":"408","description":"Request Timeout"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1purchases~1{purchaseId}~1disputes~1{purchaseDisputeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5807"}}},{"code":"408"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}"},{"label":"Get line of credit purchases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","metadata":{"seo":{"title":"Get line of credit purchases","description":"Get line of credit purchases"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.loan_purchases_get","name":"Get line of credit purchases","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get line of credit purchases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_5798","description":"The statuses of the purchases to fetch"},{"name":"statuses","in":"query","schemaId":"schema_5799","description":"The statuses of the purchases to fetch"},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter purchases by one or more card identifiers. Each value can be a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unresolvable ids are silently ignored; if no ids resolve the result"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set is empty. Omit the param for no filtering."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromEffectiveAt"},"children":[]}]}]}]},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toEffectiveAt"},"children":[]}]}]}]},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCreatedAt"},"children":[]}]}]}]},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCreatedAt"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_5800","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/purchases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"types","in":"query","required":false,"schemaId":"schema_5798"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5799"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5800"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/purchases","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","openApiOperationId":"peach.people.loans.purchases.handlers.loan_purchases_get","summary":"Get line of credit purchases","securityGroups":[{"oauth2":["draw.purchase:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasesPaging"}},"schemaId":"components/schemas/PurchasesPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchasesPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasesPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/purchases"},{"label":"Get line of credit purchases timeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","metadata":{"seo":{"title":"Get line of credit purchases timeline","description":"Get line of credit purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if effectiveAt and authorizedAt are provided in that order, Peach will"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.purchases.handlers.loan_purchases_timeline_get","name":"Get line of credit purchases timeline","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases-timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get line of credit purchases timeline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get line of credit purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided in that order, Peach will"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"check first for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. If it exists, insert into timeline using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not exist, check for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If it exists, insert into timeline using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if neither exist, insert purchase into timeline using createdAt."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["draw.purchase:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases-timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_5798","description":"The statuses of the purchases to fetch"},{"name":"statuses","in":"query","schemaId":"schema_5799","description":"The statuses of the purchases to fetch"},{"name":"cardIds","in":"query","schemaId":"schema_5694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter purchases by one or more card identifiers. Each value can be a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unresolvable ids are silently ignored; if no ids resolve the result"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set is empty. Omit the param for no filtering."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromEffectiveAt"},"children":[]}]}]}]},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toEffectiveAt"},"children":[]}]}]}]},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCreatedAt"},"children":[]}]}]}]},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for filtering objects such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCreatedAt"},"children":[]}]}]}]},{"name":"timelineOrdering","in":"query","schemaId":"schema_5803","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters used to generate a timeline of purchases. Purchases will be inserted into the timeline based on the parameters provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are available for sorting. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used if any purchases would not be inserted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into the timeline based on the attributes provided. The full timeline will be sorted either ASC ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or DESC ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). It cannot be sorted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on individual attributes. e.g. [-effectiveAt, +authorizedAt, -createdAt] is not a valid input."},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_5804","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the purchase timeline returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - oldest to newest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - newest to oldest"},"children":[]}]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases-timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/purchases-timeline","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"types","in":"query","required":false,"schemaId":"schema_5798"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5799"},{"name":"cardIds","in":"query","required":false,"schemaId":"schema_5694"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"fromEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toEffectiveAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"fromCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"toCreatedAt","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"timelineOrdering","in":"query","required":false,"schemaId":"schema_5803"},{"name":"sortOrder","in":"query","required":false,"schemaId":"schema_5804"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["draw.purchase:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/purchases-timeline","href":"line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","openApiOperationId":"peach.people.loans.purchases.handlers.loan_purchases_timeline_get","summary":"Get line of credit purchases timeline","securityGroups":[{"oauth2":["draw.purchase:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasesPaging"}},"schemaId":"components/schemas/PurchasesPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1purchases-timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchasesPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchasesPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/purchases-timeline"}],"content":{"contentType":"group","meta":{"name":"Line of Credit Purchases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Line of Credit Purchases","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents a line of credit purchase. Purchases can be made on Draw objects only. Purchases of type regular increase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"principal balance of a Draw. Some purchase types, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashBack"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are actually reduce the principal balance of a Draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each purchase has a unique identifier."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/disputes","summary":"Get line of credit purchase disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/disputes","summary":"Get draw purchase disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","summary":"Get draw purchases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","summary":"Create purchase","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases-timeline","summary":"Get draw purchases timeline","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","summary":"Get purchase by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","summary":"Update purchase","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","summary":"Get purchase disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","summary":"Create purchase dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","summary":"Get purchase dispute by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","summary":"Update purchase dispute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/purchases","summary":"Get line of credit purchases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/purchases-timeline","summary":"Get line of credit purchases timeline","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Line of Credit Migration","link":"/api-docs/api-public/line-of-credit-migration","routeSlug":"/api-docs/api-public/line-of-credit-migration","items":[{"label":"Get migration period draw data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","metadata":{"seo":{"title":"Get migration period draw data","description":"Get migration period draw data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_draw_get","name":"Get migration period draw data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get migration period draw data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:get"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:get"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_draw_get","summary":"Get migration period draw data","securityGroups":[{"oauth2":["loan.migration.period:get"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Migration period draw data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}},"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationPeriodDrawDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period"},{"label":"Create migration period draw data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","metadata":{"seo":{"title":"Create migration period draw data","description":"This endpoint allows you to pass additional details about draws in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_draw_create","name":"Create migration period draw data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create migration period draw data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to pass additional details about draws in preparation for migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"migration period\" is the period in which you execute the migration. This is the period from which the Peach system takes control over the line. This period is considered to be \"open\" at the time of the migration. The migration needs to be completed before the upcoming due date. To clarify, the upcoming due date corresponds to the previous period's statement date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Migration cutoff date\" is the most recent statement date relative to the day on which you execute the migration process. This date is also the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the migration period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Migration at date\" is the actual date on which you execute the migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called 'past period'):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Migration cutoff date' is Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you execute the migration on Aug 10, 2024, the 'migration at date' is Aug 10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Aug 22, 2024, falls in the 'migration period' that starts on Aug 1, 2024 and ends on Aug 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming due date is Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you didn't complete the migration before Aug 22, 2024, you need to cancel the loan and start the process again."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataWithRequired"}},"schemaId":"components/schemas/MigrationPeriodDrawDataWithRequired","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataWithRequired"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_draw_create","summary":"Create migration period draw data","securityGroups":[{"oauth2":["loan.migration.period:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/MigrationPeriodDrawDataWithRequired","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataWithRequired"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Migration period draw data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}},"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/MigrationPeriodDrawDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period"},{"label":"Update migration period draw data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","metadata":{"seo":{"title":"Update migration period draw data","description":"Update migration period draw data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_draw_update","name":"Update migration period draw data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update migration period draw data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawData"}},"schemaId":"components/schemas/MigrationPeriodDrawData","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawData"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_draw_update","summary":"Update migration period draw data","securityGroups":[{"oauth2":["loan.migration.period:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/MigrationPeriodDrawData","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Migration period draw data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}},"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1migration~1period/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationPeriodDrawDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodDrawDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period"},{"label":"Delete past period data","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","metadata":{"seo":{"title":"Delete past period data","description":"Deletes past period in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_periods.handlers.past_periods_data_delete","name":"Delete past period data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete past period data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes past period in preparation for migration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pastperiods:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will delete the object corresponding to the period with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no matching period is found, the system will not make any updates."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/migration/past-periods","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"dueDate","in":"query","required":true,"schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pastperiods:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-periods","href":"line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","openApiOperationId":"peach.loans.migration.past_periods.handlers.past_periods_data_delete","summary":"Delete past period data","securityGroups":[{"oauth2":["loan.migration.pastperiods:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods"},{"label":"Get past period data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","metadata":{"seo":{"title":"Get past period data","description":"Get past period in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_periods.handlers.past_periods_data_list","name":"Get past period data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get past period data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get past period in preparation for migration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pastperiods:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will return the object corresponding to the period with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no matching period is found, the system will return no results."},"children":[]}]}]}]},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"reportingToAgency","in":"query","schemaId":"schema_5808","description":"Filters to only loan types set up to report to this agency."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/migration/past-periods","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"dueDate","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"reportingToAgency","in":"query","schemaId":"schema_5808"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pastperiods:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-periods","href":"line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","openApiOperationId":"peach.loans.migration.past_periods.handlers.past_periods_data_list","summary":"Get past period data","securityGroups":[{"oauth2":["loan.migration.pastperiods:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Past period data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5809"}},"schemaId":"schema_5809"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5809","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5809"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods"},{"label":"Create past periods data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","metadata":{"seo":{"title":"Create past periods data","description":"Creates past periods in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_periods.handlers.past_periods_data_create","name":"Create past periods data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create past periods data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates past periods in preparation for migration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pastperiods:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5810"}},"schemaId":"schema_5810","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/migration/past-periods","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pastperiods:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5810"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-periods","href":"line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","openApiOperationId":"peach.loans.migration.past_periods.handlers.past_periods_data_create","summary":"Create past periods data","securityGroups":[{"oauth2":["loan.migration.pastperiods:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5810","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5810"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5811"}},"schemaId":"schema_5811"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5811","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5811"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods"},{"label":"Update past period data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","metadata":{"seo":{"title":"Update past period data","description":"Updates past period in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_periods.handlers.past_periods_data_update","name":"Update past period data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update past period data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates past period in preparation for migration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pastperiods:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will update the object corresponding to the period with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no matching period is found, the system will not make any updates."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastPeriod"}},"schemaId":"components/schemas/PastPeriod","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/migration/past-periods","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"dueDate","in":"query","required":true,"schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pastperiods:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PastPeriod"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-periods","href":"line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","openApiOperationId":"peach.loans.migration.past_periods.handlers.past_periods_data_update","summary":"Update past period data","securityGroups":[{"oauth2":["loan.migration.pastperiods:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PastPeriod","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastPeriod"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5812"}},"schemaId":"schema_5812"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-periods/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5812","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5812"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods"},{"label":"Get past transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","metadata":{"seo":{"title":"Get past transactions","description":"Get past transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","name":"Get past transactions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get past transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pasttransaction:get"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5813"},{"name":"paymentInstrumentId","in":"query","schemaId":"schema_5625","description":"The payment instrument identifier."},{"name":"transactionType","in":"query","schemaId":"schema_5814"},{"name":"serviceCreditTypes","in":"query","schemaId":"schema_5815"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which an object's effective date must match"},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"First day for which an object's effective date must match"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5816","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/migration/past-transaction","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_5813"},{"name":"paymentInstrumentId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"transactionType","in":"query","required":false,"schemaId":"schema_5814"},{"name":"serviceCreditTypes","in":"query","required":false,"schemaId":"schema_5815"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5816"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pasttransaction:get"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-transaction","href":"line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","openApiOperationId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","summary":"Get past transactions","securityGroups":[{"oauth2":["loan.migration.pasttransaction:get"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PastTransactionsPaging"}},"schemaId":"components/schemas/PastTransactionsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PastTransactionsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PastTransactionsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction"},{"label":"Create past transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","metadata":{"seo":{"title":"Create past transaction","description":"Creates past transaction in preparation for line of credit migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_create","name":"Create past transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create past transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates past transaction in preparation for line of credit migration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pasttransaction:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastTransaction"}},"schemaId":"components/schemas/PastTransaction","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/migration/past-transaction","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pasttransaction:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PastTransaction"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-transaction","href":"line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","openApiOperationId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_create","summary":"Create past transaction","securityGroups":[{"oauth2":["loan.migration.pasttransaction:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PastTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}},"schemaId":"schema_5817"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5817","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction"},{"label":"Get past transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","metadata":{"seo":{"title":"Get past transaction by ID","description":"Get past transaction by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","name":"Get past transaction by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get past transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pasttransaction:get"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pasttransaction:get"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","href":"line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","openApiOperationId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","summary":"Get past transaction by ID","securityGroups":[{"oauth2":["loan.migration.pasttransaction:get"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}},"schemaId":"schema_5817"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5817","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}"},{"label":"Update past transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","metadata":{"seo":{"title":"Update past transaction","description":"Update past transaction in preparation for line of credit migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_update","name":"Update past transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update past transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update past transaction in preparation for line of credit migration.\n\nNote: After migration, you should call the \"Update transaction\" endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.pasttransaction:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastTransactionUpdate"}},"schemaId":"components/schemas/PastTransactionUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.pasttransaction:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PastTransactionUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","href":"line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","openApiOperationId":"peach.loans.migration.past_transactions.handlers.past_transaction_data_update","summary":"Update past transaction","securityGroups":[{"oauth2":["loan.migration.pasttransaction:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PastTransactionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PastTransactionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}},"schemaId":"schema_5817"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1past-transaction~1{transactionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5817","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5817"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}"},{"label":"Get migration period LOC data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","metadata":{"seo":{"title":"Get migration period LOC data","description":"Get migration period LOC data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_loc_get","name":"Get migration period LOC data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get migration period LOC data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:get"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:get"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_loc_get","summary":"Get migration period LOC data","securityGroups":[{"oauth2":["loan.migration.period:get"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Migration period LOC data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}},"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationPeriodLOCDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/period"},{"label":"Create migration period LOC data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","metadata":{"seo":{"title":"Create migration period LOC data","description":"This endpoint allows you to pass additional details about the line in preparation for migration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_loc_create","name":"Create migration period LOC data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create migration period LOC data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to pass additional details about the line in preparation for migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Migration period\" is the period in which you execute the migration. This is the period from which the Peach system takes control over the line. This period is considered to be \"open\" at the time of the migration. The migration needs to be completed before the upcoming due date. To clarify, the upcoming due date corresponds to the previous period's statement date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Migration cutoff date\" is the most recent statement date relative to the day on which you execute the migration process. This date is also the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the migration period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Migration at date\" is the actual date on which you execute the migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Migration cutoff date\" is Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you execute the migration on Aug 10, 2024, the \"migration at date\" is Aug 10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Aug 22, 2024, falls in the \"migration period\" that starts on Aug 1, 2024 and ends on Aug 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming due date is Aug 22, 2024."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you didn't complete the migration before Aug 22, 2024, you need to cancel the loan and start the process again."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataWithRequired"}},"schemaId":"components/schemas/MigrationPeriodLOCDataWithRequired","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataWithRequired"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_loc_create","summary":"Create migration period LOC data","securityGroups":[{"oauth2":["loan.migration.period:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/MigrationPeriodLOCDataWithRequired","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataWithRequired"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Migration period LOC data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}},"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/MigrationPeriodLOCDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/period"},{"label":"Update migration period LOC data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","metadata":{"seo":{"title":"Update migration period LOC data","description":"Update migration period LOC data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.migration.migration_period.handlers.migration_period_loc_update","name":"Update migration period LOC data","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update migration period LOC data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.migration.period:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCData"}},"schemaId":"components/schemas/MigrationPeriodLOCData","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/migration/period","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.migration.period:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCData"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/migration/period","href":"line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","openApiOperationId":"peach.loans.migration.migration_period.handlers.migration_period_loc_update","summary":"Update migration period LOC data","securityGroups":[{"oauth2":["loan.migration.period:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/MigrationPeriodLOCData","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Migration period LOC data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}},"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1migration~1period/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationPeriodLOCDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationPeriodLOCDataResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/migration/period"}],"content":{"contentType":"group","meta":{"name":"Line of Credit Migration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Line of Credit Migration","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","summary":"Get migration period draw data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","summary":"Create migration period draw data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","summary":"Update migration period draw data","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-periods","summary":"Delete past period data","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-periods","summary":"Get past period data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-periods","summary":"Create past periods data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-periods","summary":"Update past period data","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-transaction","summary":"Get past transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-transaction","summary":"Create past transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","summary":"Get past transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","summary":"Update past transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/period","summary":"Get migration period LOC data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/period","summary":"Create migration period LOC data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/migration/period","summary":"Update migration period LOC data","prefix":{"name":"put","color":"put"},"badges":[],"link":"/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Expected Payments","link":"/api-docs/api-public/expected-payments","routeSlug":"/api-docs/api-public/expected-payments","items":[{"label":"Defer installment single due date","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","metadata":{"seo":{"title":"Defer installment single due date","description":"Defer single due date takes the amount in a selected due date and defers the amount to another due date in thefuture. The deferral amount can be moved to an existing due date or alternatively, to a new due date added afterthe last existing due date. These two options are mutually exclusive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_due_date_defer","name":"Defer installment single due date","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-due-date/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer installment single due date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defer single due date takes the amount in a selected due date and defers the amount to another due date in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future. The deferral amount can be moved to an existing due date or alternatively, to a new due date added after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the last existing due date. These two options are mutually exclusive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees associated with the amount in the period to be deferred will not be moved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot defer due date which is due on the day of the request. e.g. Cannot defer 1/31 on 1/31"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to installment loans."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:duedate.defer"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-due-date/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanDeferDueDate"}},"schemaId":"components/schemas/LoanDeferDueDate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-due-date/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/defer-due-date","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:duedate.defer"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanDeferDueDate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/defer-due-date","href":"expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_due_date_defer","summary":"Defer installment single due date","securityGroups":[{"oauth2":["loan:duedate.defer"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanDeferDueDate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanDeferDueDate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5818"}},"schemaId":"schema_5818"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-due-date/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5818","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5818"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/defer-due-date"},{"label":"Defer installment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","metadata":{"seo":{"title":"Defer installment schedule","description":"Defer schedule allows lenders to shift the entire expected payments schedule. There are two use cases:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_schedule_defer","name":"Defer installment schedule","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-schedule/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer installment schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defer schedule allows lenders to shift the entire expected payments schedule. There are two use cases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defer during the first period of the loan. In this scenario we \"extend\" the first period by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the requested buffer (while honoring frequency and specific days). As a result, the first due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date will be shifted in the future (and all subsequent due dates)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defer after the first period has passed. In this scenario, we defer all due dates that fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between \"today's date\" and \"today's date + buffer days\" to the end of the loan one by one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will extend the term of the loan by the number of periods equal to number of due dates that were deferred."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the current date falls on a due date, it will not be deferred as the period has ended."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to installment loans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:schedule.defer"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-schedule/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanDeferSchedule"}},"schemaId":"components/schemas/LoanDeferSchedule","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-schedule/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/defer-schedule","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:schedule.defer"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanDeferSchedule"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/defer-schedule","href":"expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_schedule_defer","summary":"Defer installment schedule","securityGroups":[{"oauth2":["loan:schedule.defer"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanDeferSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanDeferSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5819"}},"schemaId":"schema_5819"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1defer-schedule/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5819","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5819"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/defer-schedule"},{"label":"Get draw expected payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","metadata":{"seo":{"title":"Get draw expected payments","description":"Get draw expected payments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.draw_expected_payments_get","name":"Get draw expected payments","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw expected payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments","href":"expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","openApiOperationId":"peach.people.loans.expected_payments.handlers.draw_expected_payments_get","summary":"Get draw expected payments","securityGroups":[{"oauth2":["loan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}},"schemaId":"schema_5775"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments"},{"label":"Defer remaining balances for a draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","metadata":{"seo":{"title":"Defer remaining balances for a draw","description":"Defer draw single or multiple due dates. The selected due dates to defer can only be due dates for which the statement was already generated. Past due dates should always have statements. Upcoming due date can only be selected if the statement was already generated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","name":"Defer remaining balances for a draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments~1defer-remaining-balances/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer remaining balances for a draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Defer draw single or multiple due dates.\nThe selected due dates to defer can only be due dates for which\nthe statement was already generated.\nPast due dates should always have statements.\nUpcoming due date can only be selected if the statement was\nalready generated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:defer.remaining.balances"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments~1defer-remaining-balances/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"schemaId":"components/schemas/DeferRemainingBalancesRequest","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments~1defer-remaining-balances/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments/defer-remaining-balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:defer.remaining.balances"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments/defer-remaining-balances","href":"expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","openApiOperationId":"peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","summary":"Defer remaining balances for a draw","securityGroups":[{"oauth2":["loan:defer.remaining.balances"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DeferRemainingBalancesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesResponse"}},"schemaId":"components/schemas/DeferRemainingBalancesResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1expected-payments~1defer-remaining-balances/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeferRemainingBalancesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments/defer-remaining-balances"},{"label":"Get loan expected payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","metadata":{"seo":{"title":"Get loan expected payments","description":"Get loan expected payments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_expected_payments_get","name":"Get loan expected payments","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan expected payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/expected-payments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/expected-payments","href":"expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_expected_payments_get","summary":"Get loan expected payments","securityGroups":[{"oauth2":["loan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}},"schemaId":"schema_5775"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5775"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments"},{"label":"Change due dates schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","metadata":{"seo":{"title":"Change due dates schedule","description":"Change due date allows the customer to change the frequency of a loan and/or the specific day(s) thatdue dates will fall on. This is not supported for loans with periodCalculationType=statementDate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","name":"Change due dates schedule","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change due dates schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change due date allows the customer to change the frequency of a loan and/or the specific day(s) that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due dates will fall on. This is not supported for loans with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodCalculationType=statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For accounts/loans with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency!=singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka non-single term), modifications to the expected payments schedule resulting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from Change Due Date do not impact the current period. Changes are only effective starting in the next period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For accounts/loans with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency=singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only specific days can be modified. The change impacts the current (single)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period of the loan. The caller must pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDatesFrequency=singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: In certain circumstances when requesting a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first adjusted period (with the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pushed out an additional \"cycle\" in order to prevent the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the current period (with the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"falling outside the first adjusted period. To achieve this, the max "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gapBetweenDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be exceeded."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["due.date:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DueDatesRequest"}},"schemaId":"components/schemas/DueDatesRequest","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/expected-payments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["due.date:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DueDatesRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/expected-payments","href":"expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","summary":"Change due dates schedule","securityGroups":[{"oauth2":["due.date:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DueDatesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DueDatesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5820"}},"schemaId":"schema_5820"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5820","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5820"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments"},{"label":"Defer remaining balances for all active draws","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","metadata":{"seo":{"title":"Defer remaining balances for all active draws","description":"Defer line of credit single or multiple due dates. The system will defer amounts across the line of credit and all draws. The selected due dates to defer can only be due dates for which the statement was already generated. Past due dates should always have statements. Upcoming due date can only be selected if the statement was already generated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","name":"Defer remaining balances for all active draws","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments~1defer-remaining-balances/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer remaining balances for all active draws","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Defer line of credit single or multiple due dates.\nThe system will defer amounts across the line of credit and all\ndraws.\nThe selected due dates to defer can only be due dates for which\nthe statement was already generated.\nPast due dates should always have statements.\nUpcoming due date can only be selected if the statement was\nalready generated.\n\nNote: If the line of credit has origination fee, unpaid\norigination fee cannot be deferred.\nOther balances can be deferred.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:defer.remaining.balances"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments~1defer-remaining-balances/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"schemaId":"components/schemas/DeferRemainingBalancesRequest","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments~1defer-remaining-balances/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/expected-payments/defer-remaining-balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:defer.remaining.balances"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/expected-payments/defer-remaining-balances","href":"expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","openApiOperationId":"peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","summary":"Defer remaining balances for all active draws","securityGroups":[{"oauth2":["loan:defer.remaining.balances"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/DeferRemainingBalancesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesResponse"}},"schemaId":"components/schemas/DeferRemainingBalancesResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1expected-payments~1defer-remaining-balances/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeferRemainingBalancesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeferRemainingBalancesResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments/defer-remaining-balances"},{"label":"Change installment loan terms","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","metadata":{"seo":{"title":"Change installment loan terms","description":"Change loan terms creates a customer payment plan for the borrower. There are several options:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_change_terms","name":"Change installment loan terms","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change installment loan terms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change loan terms creates a customer payment plan for the borrower. There are several options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first option is passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which we use to calculate the new recurring amount going forward."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second option is passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which we use to calculate the remaining duration of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan. The third option is not passing either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case the behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is similar to the Change Due Date endpoint. The fourth option is passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we use to calculate the final payment amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the Change Due Date endpoint, for the Change Loan Terms endpoint, any modifications to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the expected payments schedule resulting from Change Loan Terms are effective from the current period. But"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"modifications to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the expected payments schedule are only effective starting in the next period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all four options, it is optional to specify a new frequency and/or specific days. Change loan terms will cancel any due date deferrals"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the current or future periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to installment loans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTerms"}},"schemaId":"components/schemas/LoanChangeLoanTerms","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/payment-plan","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTerms"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/payment-plan","href":"expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_change_terms","summary":"Change installment loan terms","securityGroups":[{"oauth2":["loan:paymentplan.create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanChangeLoanTerms","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTerms"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5820"}},"schemaId":"schema_5820"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5820","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5820"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan"}],"content":{"contentType":"group","meta":{"name":"Expected Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expected Payments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents the expected loan payments on due dates. Expected payments are what we expect to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive from a borrower on a specific date. Expected payments are created as a result of loan amortization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts and due dates can change during lifetime of a loan. For example, a borrower might change due dates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequency from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and it will lower periodic payment amount."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/defer-due-date","summary":"Defer installment single due date","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/defer-schedule","summary":"Defer installment schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments","summary":"Get draw expected payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments/defer-remaining-balances","summary":"Defer remaining balances for a draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/expected-payments","summary":"Get loan expected payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/expected-payments","summary":"Change due dates schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/expected-payments/defer-remaining-balances","summary":"Defer remaining balances for all active draws","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/payment-plan","summary":"Change installment loan terms","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","deprecated":false}]}]}]}]}},{"type":"group","label":"Obligations","link":"/api-docs/api-public/obligations","routeSlug":"/api-docs/api-public/obligations","items":[{"label":"Get draw obligations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligations_get_all","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligations_get_all","metadata":{"seo":{"title":"Get draw obligations","description":"Get draw obligations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.obligations.handlers.draw_obligations_get_all","name":"Get draw obligations","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw obligations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["obligation:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus","description":"Use this to limit results to a specific periodId."},{"name":"status","in":"query","schemaId":"schema_5821","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter a search for obligations that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unfulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will return the object corresponding to the period with due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no matching period is found, the system will return no results."},"children":[]}]}]}]},{"name":"isOpen","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is still \"open\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not final. The obligation amount can potentially change until the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period ends. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is \"sealed\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is final."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","schemaId":"schema_5821"},{"name":"fromDate","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"isOpen","in":"query","schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["obligation:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations","href":"obligations/peach.obligations.handlers.draw_obligations_get_all","openApiOperationId":"peach.obligations.handlers.draw_obligations_get_all","summary":"Get draw obligations","securityGroups":[{"oauth2":["obligation:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5822"}},"schemaId":"schema_5822"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5822","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5822"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/obligations/peach.obligations.handlers.draw_obligations_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations"},{"label":"Get draw obligation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligation_get_by_id","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligation_get_by_id","metadata":{"seo":{"title":"Get draw obligation by ID","description":"Get draw obligation by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.obligations.handlers.draw_obligation_get_by_id","name":"Get draw obligation by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations~1{obligationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw obligation by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["obligation:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"obligationId","in":"path","schemaId":"schema_5625","description":"The obligation object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations~1{obligationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"obligationId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["obligation:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}","href":"obligations/peach.obligations.handlers.draw_obligation_get_by_id","openApiOperationId":"peach.obligations.handlers.draw_obligation_get_by_id","summary":"Get draw obligation by ID","securityGroups":[{"oauth2":["obligation:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5823"}},"schemaId":"schema_5823"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1obligations~1{obligationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5823","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5823"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/obligations/peach.obligations.handlers.draw_obligation_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}"},{"label":"Get loan obligations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.obligations_get_all","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.obligations_get_all","metadata":{"seo":{"title":"Get loan obligations","description":"Get loan obligations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.obligations.handlers.obligations_get_all","name":"Get loan obligations","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan obligations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["obligation:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus","description":"Use this to limit results to a specific periodId."},{"name":"status","in":"query","schemaId":"schema_5821","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter a search for obligations that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unfulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will return the object corresponding to the period with due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no matching period is found, the system will return no results."},"children":[]}]}]}]},{"name":"isOpen","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is still \"open\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not final. The obligation amount can potentially change until the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period ends. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is \"sealed\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is final."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/obligations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","schemaId":"schema_5821"},{"name":"fromDate","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"isOpen","in":"query","schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["obligation:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/obligations","href":"obligations/peach.obligations.handlers.obligations_get_all","openApiOperationId":"peach.obligations.handlers.obligations_get_all","summary":"Get loan obligations","securityGroups":[{"oauth2":["obligation:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5824"}},"schemaId":"schema_5824"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5824","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5824"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/obligations/peach.obligations.handlers.obligations_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/obligations"},{"label":"Get loan obligation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.obligation_get_by_id","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.obligation_get_by_id","metadata":{"seo":{"title":"Get loan obligation by ID","description":"Get loan obligation by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.obligations.handlers.obligation_get_by_id","name":"Get loan obligation by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations~1{obligationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan obligation by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["obligation:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"obligationId","in":"path","schemaId":"schema_5625","description":"The obligation object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations~1{obligationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/obligations/{obligationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"obligationId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["obligation:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/obligations/{obligationId}","href":"obligations/peach.obligations.handlers.obligation_get_by_id","openApiOperationId":"peach.obligations.handlers.obligation_get_by_id","summary":"Get loan obligation by ID","securityGroups":[{"oauth2":["obligation:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5825"}},"schemaId":"schema_5825"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1obligations~1{obligationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5825","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5825"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/obligations/peach.obligations.handlers.obligation_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/obligations/{obligationId}"}],"content":{"contentType":"group","meta":{"name":"Obligations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obligations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents information on the borrower's obligation for a given loan period. It also provides information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the current status of the fulfillment of the obligation vis-à-vis the amount due and the due date. The obligation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is dynamically changing as a result of factors such as payments and service credits made, and the crossing over of due dates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations","summary":"Get draw obligations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/obligations/peach.obligations.handlers.draw_obligations_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}","summary":"Get draw obligation by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/obligations/peach.obligations.handlers.draw_obligation_get_by_id","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/obligations","summary":"Get loan obligations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/obligations/peach.obligations.handlers.obligations_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/obligations/{obligationId}","summary":"Get loan obligation by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/obligations/peach.obligations.handlers.obligation_get_by_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Periods","link":"/api-docs/api-public/periods","routeSlug":"/api-docs/api-public/periods","items":[{"label":"Get loan periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_periods","routeSlug":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_periods","metadata":{"seo":{"title":"Get loan periods","description":"Returns loan's payment periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.get_loan_periods","name":"Get loan periods","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan periods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns loan's payment periods."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date in the range to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return any period for which period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully or partially overlap with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed to get all periods in the range."},"children":[]}]}]}]},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period. The system will return the object corresponding to the period with due date equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no matching period is found, the system will return no results."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/periods","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"fromDate","in":"query","required":false,"schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"dueDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/periods","href":"periods/peach.people.loans.handlers.get_loan_periods","openApiOperationId":"peach.people.loans.handlers.get_loan_periods","summary":"Get loan periods","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Periods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanPeriodsPaging"}},"schemaId":"components/schemas/LoanPeriodsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LoanPeriodsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanPeriodsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/periods/peach.people.loans.handlers.get_loan_periods"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/periods"},{"label":"Get loan period by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_period_by_id","routeSlug":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_period_by_id","metadata":{"seo":{"title":"Get loan period by id","description":"Returns a single loan period"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.get_loan_period_by_id","name":"Get loan period by id","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{loanPeriodId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan period by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single loan period"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"loanPeriodId","in":"path","schemaId":"components/schemas/newStatus","description":"The identifier of the period.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{loanPeriodId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/periods/{loanPeriodId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanPeriodId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/periods/{loanPeriodId}","href":"periods/peach.people.loans.handlers.get_loan_period_by_id","openApiOperationId":"peach.people.loans.handlers.get_loan_period_by_id","summary":"Get loan period by id","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Loan Period","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5826"}},"schemaId":"schema_5826"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{loanPeriodId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5826","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5826"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/periods/peach.people.loans.handlers.get_loan_period_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/periods/{loanPeriodId}"}],"content":{"contentType":"group","meta":{"name":"Periods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Periods","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/periods","summary":"Get loan periods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/periods/peach.people.loans.handlers.get_loan_periods","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/periods/{loanPeriodId}","summary":"Get loan period by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/periods/peach.people.loans.handlers.get_loan_period_by_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Plans","link":"/api-docs/api-public/payment-plans","routeSlug":"/api-docs/api-public/payment-plans","items":[{"label":"Get payment plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","metadata":{"seo":{"title":"Get payment plans","description":"Returns all payment plans associated with a loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_custom_payment_plan_get","name":"Get payment plans","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all payment plans associated with a loan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.custompaymentplan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5827","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter a search for custom payment plans that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/custom-payment-plans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"status","in":"query","schemaId":"schema_5827"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.custompaymentplan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/custom-payment-plans","href":"payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","openApiOperationId":"peach.people.loans.handlers.loan_custom_payment_plan_get","summary":"Get payment plans","securityGroups":[{"oauth2":["loan.custompaymentplan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5828"}},"schemaId":"schema_5828"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5828","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5828"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans"},{"label":"Create payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","metadata":{"seo":{"title":"Create payment plan","description":"Creates a custom payment plan for the borrower. numberOfPeriods is required. If paymentPlanType=fixedAmountAndFees,then the amount is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","name":"Create payment plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a custom payment plan for the borrower. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentPlanType=fixedAmountAndFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to installment loans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.custompaymentplan:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlan"}},"schemaId":"components/schemas/LoanCustomPaymentPlan","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/custom-payment-plans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.custompaymentplan:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlan"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/custom-payment-plans","href":"payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","summary":"Create payment plan","securityGroups":[{"oauth2":["loan.custompaymentplan:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanCustomPaymentPlan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5829"}},"schemaId":"schema_5829"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5829","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5829"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans"},{"label":"Get payment plan by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","metadata":{"seo":{"title":"Get payment plan by id","description":"Return a single payment plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","name":"Get payment plan by id","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment plan by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return a single payment plan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.custompaymentplan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"paymentPlanId","in":"path","schemaId":"components/schemas/newStatus","description":"The identifier of the payment plan.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentPlanId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.custompaymentplan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}","href":"payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","openApiOperationId":"peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","summary":"Get payment plan by id","securityGroups":[{"oauth2":["loan.custompaymentplan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5829"}},"schemaId":"schema_5829"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5829","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5829"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}"},{"label":"Cancel payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","metadata":{"seo":{"title":"Cancel payment plan","description":"Use this endpoint to cancel a payment plan. Any existing payment plan must be canceled prior to creating a new payment plan. After canceling a payment plan, Peach's system will revert the loan schedule (from the current period onwards) to the previous recurring payment amount and frequency prior to creating the payment plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_custom_payment_plan_cancel","name":"Cancel payment plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to cancel a payment plan. Any existing payment plan must be canceled prior to creating a new payment plan.\nAfter canceling a payment plan, Peach's system will revert the loan schedule (from the current period onwards) to the previous\nrecurring payment amount and frequency prior to creating the payment plan.\n\nAs a result of cancellation, the loan duration and loan end date will be adjusted to match with the last non-zero expected payment,\nif required.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.custompaymentplan:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"paymentPlanId","in":"path","schemaId":"components/schemas/newStatus","description":"The identifier of the payment plan.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlanCancel"}},"schemaId":"components/schemas/LoanCustomPaymentPlanCancel","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"paymentPlanId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.custompaymentplan:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlanCancel"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}/cancel","href":"payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","openApiOperationId":"peach.people.loans.handlers.loan_custom_payment_plan_cancel","summary":"Cancel payment plan","securityGroups":[{"oauth2":["loan.custompaymentplan:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanCustomPaymentPlanCancel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCustomPaymentPlanCancel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1custom-payment-plans~1{paymentPlanId}~1cancel/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Payment Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plans are a specific type of hardship tool that can be used to create a temporary loan schedule for a borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lenders can create a payment plan by specifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentPlanType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ends, any remaining periods of the loan will be paid according to the originally scheduled recurring amount and frequency of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan at the time when the payment plan was created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the agreed upon recurring payment plan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than the originally scheduled payment amount, the system uses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExtendLoanDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ascertain whether to keep the existing loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or automatically extend the original loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the agreed upon recurring payment plan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more than the originally scheduled recurring amount, the loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be shortened to the point where the remaining balance of the loan is paid off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one active payment plan is allowed at a time. Please note that creating an active payment plan will overwrite changes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"made to the loan schedule such as due date deferrals, change due date, and change loan terms. This is because the payment plan by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"design creates a new loan schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a loan is on a payment plan, other hardship tools cannot be used. Lenders must cancel the payment plan and then make any required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan modifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan is presently for installment only."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/custom-payment-plans","summary":"Get payment plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/custom-payment-plans","summary":"Create payment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}","summary":"Get payment plan by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}/cancel","summary":"Cancel payment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","deprecated":false}]}]}]}]}},{"type":"group","label":"SCRA","link":"/api-docs/api-public/scra","routeSlug":"/api-docs/api-public/scra","items":[{"label":"Delete line of credit loan terms SCRA","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","metadata":{"seo":{"title":"Delete line of credit loan terms SCRA","description":"Removes a single SCRA interest rate (interestType=AbsoluteScra) on a line of credit loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","name":"Delete line of credit loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete line of credit loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a single SCRA interest rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=AbsoluteScra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on a line of credit loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must refer to an active SCRA interest rate on the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rateId","in":"query","schemaId":"schema_5625","description":"Unique identifier of the SCRA interest rate to update or delete.\n","required":true},{"name":"sendNotice","in":"query","schemaId":"schema_5644","description":"Deprecated. This parameter is accepted for backwards compatibility but has no effect.\nNotices are always sent.\n","deprecated":true},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"The case object unique identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"rateId","in":"query","required":true,"schemaId":"components/schemas/AnyId"},{"name":"sendNotice","in":"query","required":false,"schemaId":"schema_5644"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","openApiOperationId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","summary":"Delete line of credit loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra"},{"label":"Create line of credit loan terms SCRA","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","metadata":{"seo":{"title":"Create line of credit loan terms SCRA","description":"Creates SCRA (Servicemembers Civil Relief Act) terms for a line of credit loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","name":"Create line of credit loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create line of credit loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates SCRA (Servicemembers Civil Relief Act) terms for a line of credit loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the SCRA period, the loan rate is lowered (default 6%) and fees may be canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to line of credit loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be before or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both must fall within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan's lifetime. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot exceed 6% per US federal regulations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overlapping SCRA periods are not allowed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRA"}},"schemaId":"components/schemas/LocChangeLoanTermsSCRA","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRA"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","openApiOperationId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","summary":"Create line of credit loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LocChangeLoanTermsSCRA","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRA"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}},"schemaId":"schema_5830"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5830","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra"},{"label":"Change line of credit loan terms SCRA","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","metadata":{"seo":{"title":"Change line of credit loan terms SCRA","description":"Modifies the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra)on a line of credit loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","name":"Change line of credit loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change line of credit loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies the start date or end date of a single SCRA interest rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=AbsoluteScra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a line of credit loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be before or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both must fall within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan's lifetime. The modified SCRA period must not overlap with other SCRA plans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRAUpdate"}},"schemaId":"components/schemas/LocChangeLoanTermsSCRAUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRAUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","openApiOperationId":"peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","summary":"Change line of credit loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LocChangeLoanTermsSCRAUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocChangeLoanTermsSCRAUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}},"schemaId":"schema_5830"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1loc-payment-plan-scra/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5830","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra"},{"label":"Delete installment loan terms SCRA","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","metadata":{"seo":{"title":"Delete installment loan terms SCRA","description":"This endpoint is used for removing a single SCRA interest rate (interestType=AbsoluteScra) on a loan. Only applicable to installment loans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","name":"Delete installment loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete installment loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for removing a single SCRA interest rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=AbsoluteScra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on a loan. Only applicable to installment loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the SCRA start date is in the past, this will replay the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an existing SCRA plan is updated or deleted, the system determines whether fees should be canceled or revived based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the original SCRA plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if we are updating the SCRA plan:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expanding the SCRA period"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will cancel fees within the extended SCRA plan period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will not cancel any fees within the extended SCRA plan period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shrinking the SCRA period"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will revive any previously canceled fees within the portion of the SCRA plan period that is being removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will not revive any fees since there were no fees canceled in the original SCRA plan."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rateId","in":"query","schemaId":"schema_5625","description":"Unique identifier of the SCRA interest rate to update or delete.\n","required":true},{"name":"sendNotice","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanPaymentScheduleChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Changing the loan terms will automatically cancel an existing Autopay (if enabled). A borrower,  an agent or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API caller needs to turn on / enable a new Autopay plan after the loan terms change is completed. If the loan has Autopay enabled:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice in addition to the applicable loan terms notice."},"children":[]}]}]}]}]},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"The case object unique identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"rateId","in":"query","required":true,"schemaId":"components/schemas/AnyId"},{"name":"sendNotice","in":"query","required":false,"schemaId":"schema_5644"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","summary":"Delete installment loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra"},{"label":"Create installment loan terms SCRA","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","metadata":{"seo":{"title":"Create installment loan terms SCRA","description":"Creates a customer payment plan for the borrower in accordance with SCRA regulations. Only applicable to installment loans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","name":"Create installment loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create installment loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a customer payment plan for the borrower in accordance with SCRA regulations.\nOnly applicable to installment loans.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRA"}},"schemaId":"components/schemas/LoanChangeLoanTermsSCRA","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRA"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","summary":"Create installment loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanChangeLoanTermsSCRA","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRA"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}},"schemaId":"schema_5830"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5830","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra"},{"label":"Change installment loan terms SCRA","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","metadata":{"seo":{"title":"Change installment loan terms SCRA","description":"This endpoint is used for modifying the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra).Only applicable to installment loans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","name":"Change installment loan terms SCRA","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change installment loan terms SCRA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for modifying the start date or end date of a single SCRA interest rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=AbsoluteScra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to installment loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the SCRA start date is in the past, this will replay the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an existing SCRA plan is updated or deleted, the system determines whether fees should be canceled or revived based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the original SCRA plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if we are updating the SCRA plan:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expanding the SCRA period"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will cancel fees within the extended SCRA plan period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will not cancel any fees within the extended SCRA plan period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shrinking the SCRA period"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will revive any previously canceled fees within the portion of the SCRA plan period that is being removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCancelFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will not revive any fees since there were no fees canceled in the original SCRA plan."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:paymentplan.scra.update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRAUpdate"}},"schemaId":"components/schemas/LoanChangeLoanTermsSCRAUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/payment-plan-scra","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:paymentplan.scra.update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRAUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/payment-plan-scra","href":"scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","openApiOperationId":"peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","summary":"Change installment loan terms SCRA","securityGroups":[{"oauth2":["loan:paymentplan.scra.update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanChangeLoanTermsSCRAUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanChangeLoanTermsSCRAUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}},"schemaId":"schema_5830"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1payment-plan-scra/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5830","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5830"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra"}],"content":{"contentType":"group","meta":{"name":"SCRA"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCRA","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","summary":"Delete line of credit loan terms SCRA","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","summary":"Create line of credit loan terms SCRA","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","summary":"Change line of credit loan terms SCRA","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/payment-plan-scra","summary":"Delete installment loan terms SCRA","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/payment-plan-scra","summary":"Create installment loan terms SCRA","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/payment-plan-scra","summary":"Change installment loan terms SCRA","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Promise to Pay Plans","link":"/api-docs/api-public/promise-to-pay-plans","routeSlug":"/api-docs/api-public/promise-to-pay-plans","items":[{"label":"Evaluate Promise to Pay Plan, does not require personId","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","metadata":{"seo":{"title":"Evaluate Promise to Pay Plan, does not require personId","description":"Evaluates a Promise to Pay Plan and updates the status and isOverdue of the Promise to Pay Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","name":"Evaluate Promise to Pay Plan, does not require personId","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evaluate Promise to Pay Plan, does not require personId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evaluates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and updates the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promiseToPayPlanId","in":"path","schemaId":"schema_5625","description":"The identifier of a promise to pay plan.\n","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promiseToPayPlanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","openApiOperationId":"peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","summary":"Evaluate Promise to Pay Plan, does not require personId","securityGroups":[{"oauth2":["promise.to.pay.plan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"}],"pointer":"/paths/~1companies~1{companyId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate"},{"label":"Get Promise to Pay Plans for a Loan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","metadata":{"seo":{"title":"Get Promise to Pay Plans for a Loan","description":"Returns Promise to Pay Plans for a given Loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","name":"Get Promise to Pay Plans for a Loan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Promise to Pay Plans for a Loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"status","in":"query","schemaId":"schema_5832","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by status. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"isOverdue","in":"query","schemaId":"schema_5833","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by overdue status. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"startDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by start date after. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endDateBefore","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by end date before. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","schemaId":"schema_5832","style":"form","explode":true},{"name":"isOverdue","in":"query","schemaId":"schema_5833"},{"name":"startDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"endDateBefore","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","openApiOperationId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","summary":"Get Promise to Pay Plans for a Loan","securityGroups":[{"oauth2":["promise.to.pay.plan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5834"}},"schemaId":"schema_5834"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5834","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5834"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans"},{"label":"Create Promise to Pay Plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","metadata":{"seo":{"title":"Create Promise to Pay Plan","description":"Creates a new Promise to Pay Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","name":"Create Promise to Pay Plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Promise to Pay Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanPost"}},"schemaId":"components/schemas/PromiseToPayPlanPost","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/post/requestBody","description":"Promise to pay plan post"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanPost"}},"responseCodes":["200","201"],"pointer":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","openApiOperationId":"peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","summary":"Create Promise to Pay Plan","securityGroups":[{"oauth2":["promise.to.pay.plan:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromiseToPayPlanPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"},{"code":"201","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}},{"code":"201","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans"},{"label":"Get Promise to Pay Plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","metadata":{"seo":{"title":"Get Promise to Pay Plan","description":"Returns a Promise to Pay Plan for a given Loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","name":"Get Promise to Pay Plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Promise to Pay Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promiseToPayPlanId","in":"path","schemaId":"schema_5625","description":"The identifier of a promise to pay plan.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promiseToPayPlanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","openApiOperationId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","summary":"Get Promise to Pay Plan","securityGroups":[{"oauth2":["promise.to.pay.plan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}"},{"label":"Cancel Promise to Pay Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","metadata":{"seo":{"title":"Cancel Promise to Pay Plan","description":"Cancels a Promise to Pay Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","name":"Cancel Promise to Pay Plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Promise to Pay Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promiseToPayPlanId","in":"path","schemaId":"schema_5625","description":"The identifier of a promise to pay plan.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanCancel"}},"schemaId":"components/schemas/PromiseToPayPlanCancel","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1cancel/put/requestBody","description":"Promise to pay plan cancel"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promiseToPayPlanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanCancel"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/cancel","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","openApiOperationId":"peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","summary":"Cancel Promise to Pay Plan","securityGroups":[{"oauth2":["promise.to.pay.plan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromiseToPayPlanCancel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromiseToPayPlanCancel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/cancel"},{"label":"Evaluate Promise to Pay Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","metadata":{"seo":{"title":"Evaluate Promise to Pay Plan","description":"Evaluates a Promise to Pay Plan and updates the status and isOverdue of the Promise to Pay Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","name":"Evaluate Promise to Pay Plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evaluate Promise to Pay Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evaluates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and updates the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promiseToPayPlanId","in":"path","schemaId":"schema_5625","description":"The identifier of a promise to pay plan.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promiseToPayPlanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","openApiOperationId":"peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","summary":"Evaluate Promise to Pay Plan","securityGroups":[{"oauth2":["promise.to.pay.plan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Promise to pay plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}},"schemaId":"schema_5831"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promise-to-pay-plans~1{promiseToPayPlanId}~1evaluate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5831"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate"},{"label":"Get Promise to Pay Plans for a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","metadata":{"seo":{"title":"Get Promise to Pay Plans for a company","description":"Returns Promise to Pay Plans for a given company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","name":"Get Promise to Pay Plans for a company","isWebhook":false,"pointer":"/paths/~1promise-to-pay-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Promise to Pay Plans for a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s for a given company."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["promise.to.pay.plan:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"status","in":"query","schemaId":"schema_5832","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by status. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"isOverdue","in":"query","schemaId":"schema_5833","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by overdue status. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"startDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by start date after. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endDateBefore","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by end date before. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1promise-to-pay-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/promise-to-pay-plans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"status","in":"query","schemaId":"schema_5832","style":"form","explode":true},{"name":"isOverdue","in":"query","schemaId":"schema_5833"},{"name":"startDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"endDateBefore","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["promise.to.pay.plan:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/promise-to-pay-plans","href":"promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","openApiOperationId":"peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","summary":"Get Promise to Pay Plans for a company","securityGroups":[{"oauth2":["promise.to.pay.plan:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5834"}},"schemaId":"schema_5834"}],"pointer":"/paths/~1promise-to-pay-plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5834","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5834"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company"}],"panels":[]}]},"httpPath":"/promise-to-pay-plans"}],"content":{"contentType":"group","meta":{"name":"Promise to Pay Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Promise to Pay Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a group of Promise to Pay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periods— unscheduled payments that was verbally committed by a borrower. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defined on an account level. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s are not guaranteed payments. They are used to track"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verbal commitments made by borrowers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: When creating or updating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", either pass a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, or pass schedule descriptor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes— "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mixing the two"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"approaches is not allowed."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","summary":"Evaluate Promise to Pay Plan, does not require personId","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","summary":"Get Promise to Pay Plans for a Loan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","summary":"Create Promise to Pay Plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}","summary":"Get Promise to Pay Plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/cancel","summary":"Cancel Promise to Pay Plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","summary":"Evaluate Promise to Pay Plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","deprecated":false},{"title":"/promise-to-pay-plans","summary":"Get Promise to Pay Plans for a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/api-docs/api-public/fees","routeSlug":"/api-docs/api-public/fees","items":[{"label":"Get fee types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fee_types_get","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fee_types_get","metadata":{"seo":{"title":"Get fee types","description":"Get fee types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.fee_types_get","name":"Get fee types","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1fee-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fee types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:types.list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1fee-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loan-types/{loanTypeId}/fee-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:types.list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/loan-types/{loanTypeId}/fee-types","href":"fees/peach.people.loans.fees.handlers.fee_types_get","openApiOperationId":"peach.people.loans.fees.handlers.fee_types_get","summary":"Get fee types","securityGroups":[{"oauth2":["loan:types.list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5835"}},"schemaId":"schema_5835"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1fee-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5835","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5835"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.fee_types_get"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/fee-types"},{"label":"Cancel dynamic fees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel","metadata":{"seo":{"title":"Cancel dynamic fees","description":"Cancel dynamic fees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.fees_cancel","name":"Cancel dynamic fees","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel-fees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel dynamic fees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:cancel.dynamicfee"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel-fees/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clearExternalId","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will clear the external ID for the object."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel-fees/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5836"}},"schemaId":"schema_5836","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel-fees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/cancel-fees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"clearExternalId","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:cancel.dynamicfee"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5836"}},"responseCodes":["204","423"],"pointer":"/people/{personId}/loans/{loanId}/cancel-fees","href":"fees/peach.people.loans.fees.handlers.fees_cancel","openApiOperationId":"peach.people.loans.fees.handlers.fees_cancel","summary":"Cancel dynamic fees","securityGroups":[{"oauth2":["loan:cancel.dynamicfee"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5836","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5836"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Canceled"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cancel-fees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.fees_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cancel-fees"},{"label":"Update draw fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.handlers.update_draw_fee","routeSlug":"/api-docs/api-public/fees/peach.people.loans.handlers.update_draw_fee","metadata":{"seo":{"title":"Update draw fee","description":"This endpoint allows lenders to change the draw fee amount. The system will update the draw fee amount and replay the loan from the draw activation date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.update_draw_fee","name":"Update draw fee","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1fees~1draw/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows lenders to change the draw fee amount. The system will update the draw fee amount and replay the loan from the draw activation date.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1fees~1draw/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1fees~1draw/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5837"}},"schemaId":"schema_5837","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1fees~1draw/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5837"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw","href":"fees/peach.people.loans.handlers.update_draw_fee","openApiOperationId":"peach.people.loans.handlers.update_draw_fee","summary":"Update draw fee","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1fees~1draw/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.handlers.update_draw_fee"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw"},{"label":"Get fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_get","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_get","metadata":{"seo":{"title":"Get fees","description":"Get fees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.fees_get","name":"Get fees","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:fees.list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDraws","in":"query","schemaId":"schema_5644","description":"If set to true, includes the fees on all draws on the line of credit.\n"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/fees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"includeDraws","in":"query","schemaId":"schema_5644"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:fees.list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/fees","href":"fees/peach.people.loans.fees.handlers.fees_get","openApiOperationId":"peach.people.loans.fees.handlers.fees_get","summary":"Get fees","securityGroups":[{"oauth2":["loan:fees.list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5838"}},"schemaId":"schema_5838"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5838","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5838"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.fees_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/fees"},{"label":"Charge dynamic fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_post","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_post","metadata":{"seo":{"title":"Charge dynamic fee","description":"Charge dynamic fee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.fees_post","name":"Charge dynamic fee","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge dynamic fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:charge.dynamicfee"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5839"}},"schemaId":"schema_5839","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/fees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:charge.dynamicfee"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5839"}},"responseCodes":["200","409","412"],"pointer":"/people/{personId}/loans/{loanId}/fees","href":"fees/peach.people.loans.fees.handlers.fees_post","openApiOperationId":"peach.people.loans.fees.handlers.fees_post","summary":"Charge dynamic fee","securityGroups":[{"oauth2":["loan:charge.dynamicfee"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5839","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5839"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5840"}},"schemaId":"schema_5840"},{"code":"409","description":"Duplicate fee external id."},{"code":"412","description":"Fee not charged","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5841"}},"schemaId":"schema_5841"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5840","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5840"}}},{"code":"409"},{"code":"412","schemaId":"schema_5841","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5841"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.fees_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/fees"},{"label":"Update origination fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.handlers.update_origination_fee","routeSlug":"/api-docs/api-public/fees/peach.people.loans.handlers.update_origination_fee","metadata":{"seo":{"title":"Update origination fee","description":"This endpoint allows lenders to change the origination fee amount. The system will update the origination fee amount and replay the loan from the activation date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.update_origination_fee","name":"Update origination fee","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1origination/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update origination fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows lenders to change the origination fee amount. The system will update the origination fee amount and replay the loan from the activation date.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1origination/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1origination/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5842"}},"schemaId":"schema_5842","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1origination/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/fees/origination","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5842"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/fees/origination","href":"fees/peach.people.loans.handlers.update_origination_fee","openApiOperationId":"peach.people.loans.handlers.update_origination_fee","summary":"Update origination fee","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5842","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5842"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1origination/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.handlers.update_origination_fee"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/fees/origination"},{"label":"Update dynamic fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.dynamic_fee_update","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.dynamic_fee_update","metadata":{"seo":{"title":"Update dynamic fee","description":"Update dynamic fee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.dynamic_fee_update","name":"Update dynamic fee","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update dynamic fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:fees.update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"loanFeeId","in":"path","schemaId":"schema_5625","description":"The loan fee identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make the process synchronous. Only relevant for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates. Updating this value will trigger a replay."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5843"}},"schemaId":"schema_5843","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanFeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:fees.update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5843"}},"responseCodes":["204","409","423"],"pointer":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}","href":"fees/peach.people.loans.fees.handlers.dynamic_fee_update","openApiOperationId":"peach.people.loans.fees.handlers.dynamic_fee_update","summary":"Update dynamic fee","securityGroups":[{"oauth2":["loan:fees.update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5843","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5843"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated."},{"code":"409","description":"Duplicate fee external id."},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"409"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.dynamic_fee_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}"},{"label":"Cancel dynamic fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel_one","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel_one","metadata":{"seo":{"title":"Cancel dynamic fee","description":"Cancel dynamic fee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.fees.handlers.fees_cancel_one","name":"Cancel dynamic fee","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel dynamic fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:cancel.dynamicfee"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"loanFeeId","in":"path","schemaId":"schema_5625","description":"The loan fee identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clearExternalId","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will clear the external ID for the object."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"schemaId":"components/schemas/CaseId","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanFeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"clearExternalId","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:cancel.dynamicfee"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaseId"}},"responseCodes":["204","423"],"pointer":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel","href":"fees/peach.people.loans.fees.handlers.fees_cancel_one","openApiOperationId":"peach.people.loans.fees.handlers.fees_cancel_one","summary":"Cancel dynamic fee","securityGroups":[{"oauth2":["loan:cancel.dynamicfee"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CaseId","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaseId"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Canceled"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1fees~1{loanFeeId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/peach.people.loans.fees.handlers.fees_cancel_one"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":"This object contains information about the fees that are charged to the loan, including draw, origination or\ndynamic fees, such as late fees."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/loan-types/{loanTypeId}/fee-types","summary":"Get fee types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.fee_types_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/cancel-fees","summary":"Cancel dynamic fees","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.fees_cancel","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw","summary":"Update draw fee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/peach.people.loans.handlers.update_draw_fee","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/fees","summary":"Get fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.fees_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/fees","summary":"Charge dynamic fee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.fees_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/fees/origination","summary":"Update origination fee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/peach.people.loans.handlers.update_origination_fee","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}","summary":"Update dynamic fee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.dynamic_fee_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel","summary":"Cancel dynamic fee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/peach.people.loans.fees.handlers.fees_cancel_one","deprecated":false}]}]}]}]}},{"type":"group","label":"Rates","link":"/api-docs/api-public/rates","routeSlug":"/api-docs/api-public/rates","items":[{"label":"Get draw effective rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_effective_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_effective_rates_get","metadata":{"seo":{"title":"Get draw effective rates","description":"This endpoint returns rates details of a draw for a given date(s).Interest rates:If two or more interest rates are active on the same date (aka overlap), the Peach system selects the lowest rate (also called effective rate) to accrue interest.Promo rates:If two or more promo rates are active on the same date (aka overlap), the Peach system sums up the rates as \"effective\" promo rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.draw_effective_rates_get","name":"Get draw effective rates","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1effective-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw effective rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns rates details of a draw for a given date(s)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rates:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more interest rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), the Peach system selects the lowest rate (also called effective rate) to accrue interest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promo rates:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more promo rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), the Peach system sums up the rates as \"effective\" promo rate."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1effective-rates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The from date. Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the rates for a specific date."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The to date. Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the rates for a specific date."},"children":[]}]}]}]},{"name":"periodIds","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of period IDs to specify the requested dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an alternative to using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the requested dates;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of specifying a range of dates, every date falling within all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the specified periods will be returned. Note this might result in non-consecutive dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"periodDueDates","in":"query","schemaId":"schema_5844","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of period due dates to specify the requested dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an alternative to specifying the periods of concern with IDs and instead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referencing them by their due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is also an alternative to using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the requested dates;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of specifying a range of dates, every date falling within all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the specified periods will be returned. Note this might result in non-consecutive dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1effective-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/effective-rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"periodIds","in":"query","schemaId":"schema_5632"},{"name":"periodDueDates","in":"query","schemaId":"schema_5844"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/effective-rates","href":"rates/peach.people.loans.handlers.draw_effective_rates_get","openApiOperationId":"peach.people.loans.handlers.draw_effective_rates_get","summary":"Get draw effective rates","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5845"}},"schemaId":"schema_5845"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1effective-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5845","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5845"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.draw_effective_rates_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/effective-rates"},{"label":"Get draw rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_get","metadata":{"seo":{"title":"Get draw rates","description":"Get draw rates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.draw_rates_get","name":"Get draw rates","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","href":"rates/peach.people.loans.handlers.draw_rates_get","openApiOperationId":"peach.people.loans.handlers.draw_rates_get","summary":"Get draw rates","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5846"}},"schemaId":"schema_5846"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5846","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5846"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.draw_rates_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates"},{"label":"Add draw rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_add","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_add","metadata":{"seo":{"title":"Add draw rate","description":"This endpoint is used for adding rates. A draw can have multiple rates. If two or more interestRate overlap on the same datewe use the lowest value. If two or more promoRate overlap on the same date, we take the sum of the promo rates for the givenday, and cap this rate at the maximum interest rate for the given day (to avoid accruing negative interest)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.draw_rates_add","name":"Add draw rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add draw rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for adding rates. A draw can have multiple rates. If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overlap on the same date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we use the lowest value. If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overlap on the same date, we take the sum of the promo rates for the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day, and cap this rate at the maximum interest rate for the given day (to avoid accruing negative interest)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The added "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will default to the existing interest type set on the loan at the time of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origination (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.interestRate.interestType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The added "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be within the bounds of any corresponding minimum and maximum rate range"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration that is found on the loan type (if any)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5847"}},"schemaId":"schema_5847","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5847"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","href":"rates/peach.people.loans.handlers.draw_rates_add","openApiOperationId":"peach.people.loans.handlers.draw_rates_add","summary":"Add draw rate","securityGroups":[{"oauth2":["rates:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5847","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5847"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}},"schemaId":"schema_5848"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.draw_rates_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates"},{"label":"Remove draw rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_delete","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_delete","metadata":{"seo":{"title":"Remove draw rate","description":"This endpoint is used for removing a single interest or promo rate. The deletion of aninterest rate cannot lead to a gap in the loan where there is no reference rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.draw_rates_delete","name":"Remove draw rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove draw rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for removing a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate. The deletion of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest rate cannot lead to a gap in the loan where there is no reference rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rates where setAtActivation is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be deleted with a special force permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"rateId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique identifier of an interest or promo rate.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"caseId","in":"query","schemaId":"schema_5625","description":"Filter by case's object unique identifier. Can be Peach or lender's external identifier.\n"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"caseId","in":"query","schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","href":"rates/peach.people.loans.handlers.draw_rates_delete","openApiOperationId":"peach.people.loans.handlers.draw_rates_delete","summary":"Remove draw rate","securityGroups":[{"oauth2":["rates:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.draw_rates_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}"},{"label":"Update draw rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_update","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_update","metadata":{"seo":{"title":"Update draw rate","description":"This endpoint is used for updating a single interest or promo rate (don't pass both in the same call). The updating of aninterest rate cannot lead to a gap in the loan where there is no reference interest rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.draw_rates_update","name":"Update draw rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for updating a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate (don't pass both in the same call). The updating of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest rate cannot lead to a gap in the loan where there is no reference interest rate."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"rateId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique identifier of an interest or promo rate.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5849"}},"schemaId":"schema_5849","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5849"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","href":"rates/peach.people.loans.handlers.draw_rates_update","openApiOperationId":"peach.people.loans.handlers.draw_rates_update","summary":"Update draw rate","securityGroups":[{"oauth2":["rates:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5849","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5849"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}},"schemaId":"schema_5848"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rates~1{rateId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.draw_rates_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}"},{"label":"Get loan effective rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_effective_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_effective_rates_get","metadata":{"seo":{"title":"Get loan effective rates","description":"This endpoint returns rates details of a loan for given date(s)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_effective_rates_get","name":"Get loan effective rates","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1effective-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan effective rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns rates details of a loan for given date(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"rates/peach.people.loans.handlers.loan_effective_rates_get/request/interest-rates:","deepLinkHash":"/rates/peach.people.loans.handlers.loan_effective_rates_get#rates/peach.people.loans.handlers.loan_effective_rates_get/request/interest-rates:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more interest rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), the Peach system selects the lowest rate (also called \"effective rate\") to accrue interest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promo rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more promo rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), the Peach system sums up the rates as \"effective\" promo rate."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1effective-rates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"from\" date (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the rates for a specific date."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"to\" date (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the rates for a specific date."},"children":[]}]}]}]},{"name":"periodIds","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of period IDs to specify the requested dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an alternative to using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the requested dates;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of specifying a range of dates, every date falling within all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the specified periods will be returned. Note this might result in non-consecutive dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"periodDueDates","in":"query","schemaId":"schema_5844","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of period due dates to specify the requested dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an alternative to specifying the periods of concern with IDs and instead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referencing them by their due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is also an alternative to using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the requested dates;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of specifying a range of dates, every date falling within all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the specified periods will be returned. Note this might result in non-consecutive dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1effective-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/effective-rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"periodIds","in":"query","schemaId":"schema_5632"},{"name":"periodDueDates","in":"query","schemaId":"schema_5844"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/effective-rates","href":"rates/peach.people.loans.handlers.loan_effective_rates_get","openApiOperationId":"peach.people.loans.handlers.loan_effective_rates_get","summary":"Get loan effective rates","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5845"}},"schemaId":"schema_5845"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1effective-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5845","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5845"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.loan_effective_rates_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/effective-rates"},{"label":"Get loan rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_get","metadata":{"seo":{"title":"Get loan rates","description":"Get loan rates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_rates_get","name":"Get loan rates","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/rates","href":"rates/peach.people.loans.handlers.loan_rates_get","openApiOperationId":"peach.people.loans.handlers.loan_rates_get","summary":"Get loan rates","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5846"}},"schemaId":"schema_5846"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5846","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5846"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.loan_rates_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rates"},{"label":"Add loan rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_add","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_add","metadata":{"seo":{"title":"Add loan rate","description":"This endpoint is used for adding rates. A loan can have multiple rates. If two or more interestRateoverlap on the same date we use the lowest value. If two or more promoRate overlap on the same date, wetake the sum of the promo rates for the given day, and cap this rate at the maximum interest rate for thegiven day (to avoid accruing negative interest)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_rates_add","name":"Add loan rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add loan rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for adding rates. A loan can have multiple rates. If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overlap on the same date we use the lowest value. If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overlap on the same date, we"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"take the sum of the promo rates for the given day, and cap this rate at the maximum interest rate for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given day (to avoid accruing negative interest)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The added "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will default to the existing interest type set on the loan at the time of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origination (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.interestRate.interestType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The added "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be within the bounds of any corresponding minimum and maximum rate range"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration that is found on the loan type (if any)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5847"}},"schemaId":"schema_5847","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5847"}},"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/rates","href":"rates/peach.people.loans.handlers.loan_rates_add","openApiOperationId":"peach.people.loans.handlers.loan_rates_add","summary":"Add loan rate","securityGroups":[{"oauth2":["rates:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5847","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5847"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}},"schemaId":"schema_5848"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.loan_rates_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rates"},{"label":"Remove loan rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_delete","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_delete","metadata":{"seo":{"title":"Remove loan rate","description":"This endpoint is used for removing a single interest or promo rate. The deletion of aninterest rate cannot lead to a gap in the loan where there is no reference rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_rates_delete","name":"Remove loan rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove loan rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for removing a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate. The deletion of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest rate cannot lead to a gap in the loan where there is no reference rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rates where setAtActivation is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be deleted with a special force permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"rateId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique identifier of an interest or promo rate.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"caseId","in":"query","schemaId":"schema_5625","description":"Filter by case's object unique identifier. Can be Peach or lender's external identifier.\n"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/rates/{rateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"caseId","in":"query","schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/rates/{rateId}","href":"rates/peach.people.loans.handlers.loan_rates_delete","openApiOperationId":"peach.people.loans.handlers.loan_rates_delete","summary":"Remove loan rate","securityGroups":[{"oauth2":["rates:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.loan_rates_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rates/{rateId}"},{"label":"Update loan rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_update","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_update","metadata":{"seo":{"title":"Update loan rate","description":"This endpoint is used for updating a single interest or promo rate. (don't pass both in the same call). The updating of aninterest rate cannot lead to a gap in the loan where there is no reference interest rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_rates_update","name":"Update loan rate","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for updating a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate. (don't pass both in the same call). The updating of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest rate cannot lead to a gap in the loan where there is no reference interest rate."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"rateId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique identifier of an interest or promo rate.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5849"}},"schemaId":"schema_5849","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/rates/{rateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5849"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/rates/{rateId}","href":"rates/peach.people.loans.handlers.loan_rates_update","openApiOperationId":"peach.people.loans.handlers.loan_rates_update","summary":"Update loan rate","securityGroups":[{"oauth2":["rates:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5849","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5849"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}},"schemaId":"schema_5848"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rates~1{rateId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5848"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/peach.people.loans.handlers.loan_rates_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rates/{rateId}"}],"content":{"contentType":"group","meta":{"name":"Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rates","showPageActions":true},{"nodeType":"markdoc","content":"This object represents the interest and promo rates of the loan. You can modify interest and promo rates at any time.\nIf a rate is modified or added with an effective date in the past, we will recalculate loan balances retroactively and\nfuture expected payments from the effective date. If a rate is modified or added with effective date in the future, we\nwill recalculate future expected payments only."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/effective-rates","summary":"Get draw effective rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/peach.people.loans.handlers.draw_effective_rates_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","summary":"Get draw rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/peach.people.loans.handlers.draw_rates_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","summary":"Add draw rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rates/peach.people.loans.handlers.draw_rates_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","summary":"Remove draw rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rates/peach.people.loans.handlers.draw_rates_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","summary":"Update draw rate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rates/peach.people.loans.handlers.draw_rates_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/effective-rates","summary":"Get loan effective rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/peach.people.loans.handlers.loan_effective_rates_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rates","summary":"Get loan rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/peach.people.loans.handlers.loan_rates_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rates","summary":"Add loan rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rates/peach.people.loans.handlers.loan_rates_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rates/{rateId}","summary":"Remove loan rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rates/peach.people.loans.handlers.loan_rates_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rates/{rateId}","summary":"Update loan rate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rates/peach.people.loans.handlers.loan_rates_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Caps","link":"/api-docs/api-public/rate-caps","routeSlug":"/api-docs/api-public/rate-caps","items":[{"label":"Get draw rate caps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","metadata":{"seo":{"title":"Get draw rate caps","description":"Get draw rate caps"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.draw_rate_caps_get","name":"Get draw rate caps","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw rate caps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","href":"rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","openApiOperationId":"peach.loans.rate_caps.handlers.draw_rate_caps_get","summary":"Get draw rate caps","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5850"}},"schemaId":"schema_5850"},{"code":"404","description":"Loan or draw not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5850","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5850"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps"},{"label":"Add draw rate cap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","metadata":{"seo":{"title":"Add draw rate cap","description":"This endpoint is used for adding rate caps to a draw. If two ormore rate caps overlap on the same date, we will use the lowest value.This defines the maximum interest rate that can accrue on a drawto ensure interest accrual never exceeds the cap. You can define thestartDate and endDate for each rate cap."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.draw_rate_cap_add","name":"Add draw rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add draw rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for adding rate caps to a draw. If two or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"more rate caps overlap on the same date, we will use the lowest value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This defines the maximum interest rate that can accrue on a draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to ensure interest accrual never exceeds the cap. You can define the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each rate cap."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rate cap is added for past periods and the interest rate exceeds the cap,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we will replay the loan to apply the capped rate. If a rate cap is added for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"past periods and the effective interest rate is unchanged, we will not replay the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A borrower on active duty needs their rate capped at 36% per"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MLA regulations. If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateCap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, an index rate change could increase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan rate beyond the regulatory limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original rate: 28% "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 5% index rate = 33% (under cap)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated rate: 28% "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 9% index rate= 37% (over cap)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"schemaId":"components/schemas/RateCapAdd","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"responseCodes":["200","400","404"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","href":"rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","openApiOperationId":"peach.loans.rate_caps.handlers.draw_rate_cap_add","summary":"Add draw rate cap","securityGroups":[{"oauth2":["rates:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RateCapAdd","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}},"schemaId":"schema_5851"},{"code":"400","description":"Bad request - validation error"},{"code":"404","description":"Loan or draw not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps"},{"label":"Delete draw rate cap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","metadata":{"seo":{"title":"Delete draw rate cap","description":"This endpoint is used for removing a single rate cap on a draw."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.draw_rate_cap_delete","name":"Delete draw rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete draw rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for removing a single rate cap on a draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a draw rate was capped at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and removing this rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cap updates the effective interest rate, then we will replay the loan. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan rate is not affected by the removal of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then we will not replay the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"rateCapId","in":"path","schemaId":"schema_5852","description":"The unique identifier of the Rate Cap we wish to retrieve.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateCapId","in":"path","required":true,"example":"RC-ABCD-1234","schemaId":"components/schemas/RateCapId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","href":"rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","openApiOperationId":"peach.loans.rate_caps.handlers.draw_rate_cap_delete","summary":"Delete draw rate cap","securityGroups":[{"oauth2":["rates:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5853"}},"schemaId":"schema_5853"},{"code":"404","description":"Loan, draw, or rate cap not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5853","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5853"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}"},{"label":"Update draw rate cap","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","metadata":{"seo":{"title":"Update draw rate cap","description":"This endpoint is used for updating a single rate cap on a draw."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.draw_rate_cap_update","name":"Update draw rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update draw rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for updating a single rate cap on a draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rate cap is updated on a draw for past periods and the draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate exceeds the cap, we will replay the loan to apply the capped rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rate cap is added for past periods and the draw rate is not affected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update, then we will not replay the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"rateCapId","in":"path","schemaId":"schema_5852","description":"The unique identifier of the Rate Cap we wish to retrieve.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"schemaId":"components/schemas/RateCapUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateCapId","in":"path","required":true,"example":"RC-ABCD-1234","schemaId":"components/schemas/RateCapId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"responseCodes":["200","400","404"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","href":"rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","openApiOperationId":"peach.loans.rate_caps.handlers.draw_rate_cap_update","summary":"Update draw rate cap","securityGroups":[{"oauth2":["rates:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RateCapUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}},"schemaId":"schema_5851"},{"code":"400","description":"Bad request - validation error"},{"code":"404","description":"Loan, draw, or rate cap not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1rate-caps~1{rateCapId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}"},{"label":"Get loan rate caps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","metadata":{"seo":{"title":"Get loan rate caps","description":"Get loan rate caps"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.loan_rate_caps_get","name":"Get loan rate caps","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan rate caps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/rate-caps","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/loans/{loanId}/rate-caps","href":"rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","openApiOperationId":"peach.loans.rate_caps.handlers.loan_rate_caps_get","summary":"Get loan rate caps","securityGroups":[{"oauth2":["rates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5850"}},"schemaId":"schema_5850"},{"code":"404","description":"Loan not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5850","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5850"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps"},{"label":"Add loan rate cap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","metadata":{"seo":{"title":"Add loan rate cap","description":"This endpoint is used for adding rate caps to a loan. If two ormore rate caps overlap on the same date, we will use the lowest value.This defines the maximum interest rate that can accrue on a loanto ensure interest accrual never exceeds the cap. You can define thestartDate and endDate for each rate cap."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.loan_rate_cap_add","name":"Add loan rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add loan rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for adding rate caps to a loan. If two or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"more rate caps overlap on the same date, we will use the lowest value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This defines the maximum interest rate that can accrue on a loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to ensure interest accrual never exceeds the cap. You can define the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each rate cap."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rate cap is added for past periods and the interest rate exceeds the cap,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we will replay the loan to apply the capped rate. If a rate cap is added for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"past periods and the effective interest rate is unchanged, we will not replay the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A borrower on active duty needs their rate capped at 36% per"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MLA regulations. If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateCap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, an index rate change could increase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan rate beyond the regulatory limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original rate: 28% "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 5% index rate = 33% (under cap)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated rate: 28% "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 9% index rate= 37% (over cap)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"schemaId":"components/schemas/RateCapAdd","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/rate-caps","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"responseCodes":["200","400","404"],"pointer":"/people/{personId}/loans/{loanId}/rate-caps","href":"rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","openApiOperationId":"peach.loans.rate_caps.handlers.loan_rate_cap_add","summary":"Add loan rate cap","securityGroups":[{"oauth2":["rates:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RateCapAdd","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapAdd"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}},"schemaId":"schema_5851"},{"code":"400","description":"Bad request - validation error"},{"code":"404","description":"Loan not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps"},{"label":"Delete loan rate cap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","metadata":{"seo":{"title":"Delete loan rate cap","description":"This endpoint is used for removing a single rate cap on a loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.loan_rate_cap_delete","name":"Delete loan rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete loan rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for removing a single rate cap on a loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a loan rate was capped at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and removing this rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cap updates the effective interest rate, then we will replay the loan. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan rate is not affected by the removal of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then we will not replay the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"rateCapId","in":"path","schemaId":"schema_5852","description":"The unique identifier of the Rate Cap we wish to retrieve.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateCapId","in":"path","required":true,"example":"RC-ABCD-1234","schemaId":"components/schemas/RateCapId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","href":"rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","openApiOperationId":"peach.loans.rate_caps.handlers.loan_rate_cap_delete","summary":"Delete loan rate cap","securityGroups":[{"oauth2":["rates:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5853"}},"schemaId":"schema_5853"},{"code":"404","description":"Loan or rate cap not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5853","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5853"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}"},{"label":"Update loan rate cap","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","metadata":{"seo":{"title":"Update loan rate cap","description":"This endpoint is used for updating a single rate cap on a loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.rate_caps.handlers.loan_rate_cap_update","name":"Update loan rate cap","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan rate cap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for updating a single rate cap on a loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rate cap is updated on a loan for past periods and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan rate exceeds the cap, we will replay the loan to apply"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the capped rate. If a rate cap is added for past periods and the loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate is not affected by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update, then we will not replay the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["rates:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"rateCapId","in":"path","schemaId":"schema_5852","description":"The unique identifier of the Rate Cap we wish to retrieve.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"schemaId":"components/schemas/RateCapUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"rateCapId","in":"path","required":true,"example":"RC-ABCD-1234","schemaId":"components/schemas/RateCapId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["rates:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"responseCodes":["200","400","404"],"pointer":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","href":"rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","openApiOperationId":"peach.loans.rate_caps.handlers.loan_rate_cap_update","summary":"Update loan rate cap","securityGroups":[{"oauth2":["rates:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/RateCapUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateCapUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}},"schemaId":"schema_5851"},{"code":"400","description":"Bad request - validation error"},{"code":"404","description":"Loan or rate cap not found"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1rate-caps~1{rateCapId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5851"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}"}],"content":{"contentType":"group","meta":{"name":"Rate Caps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Caps","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate caps are rate limits applied to loans and draws to ensure compliance with various regulations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They prevent calculated interest rates (spread + index) from exceeding specified maximums. Rate caps can be applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to loans and line of credit draws. When multiple rate caps overlap on the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dates, the system automatically uses the lowest value to ensure compliance."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","summary":"Get draw rate caps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","summary":"Add draw rate cap","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","summary":"Delete draw rate cap","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","summary":"Update draw rate cap","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rate-caps","summary":"Get loan rate caps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rate-caps","summary":"Add loan rate cap","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","summary":"Delete loan rate cap","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","summary":"Update loan rate cap","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/api-docs/api-public/transactions","routeSlug":"/api-docs/api-public/transactions","items":[{"label":"Get transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.loan_transactions_get_all","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.loan_transactions_get_all","metadata":{"seo":{"title":"Get transactions","description":"Get transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.loan_transactions_get_all","name":"Get transactions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5813"},{"name":"paymentInstrumentId","in":"query","schemaId":"schema_5625","description":"The payment instrument identifier."},{"name":"isExternal","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Fetch entities that are marked external."},{"name":"isVirtual","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"transactionType","in":"query","schemaId":"schema_5814"},{"name":"paymentReason","in":"query","schemaId":"schema_5854"},{"name":"retryOriginalTransactionId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"serviceCreditTypes","in":"query","schemaId":"schema_5815"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which an object's effective date must match"},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"First day for which an object's effective date must match"},{"name":"fromDisplayDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Return only transactions with displayDate on or after this date (inclusive)."},{"name":"toDisplayDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Return only transactions with displayDate on or before this date (inclusive)."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5816","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/transactions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_5813"},{"name":"paymentInstrumentId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"isExternal","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"isVirtual","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"transactionType","in":"query","required":false,"schemaId":"schema_5814"},{"name":"paymentReason","in":"query","required":false,"schemaId":"schema_5854"},{"name":"retryOriginalTransactionId","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"serviceCreditTypes","in":"query","required":false,"schemaId":"schema_5815"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"fromDisplayDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"toDisplayDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5816"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions","href":"transactions/peach.transactions.handlers.loan_transactions_get_all","openApiOperationId":"peach.transactions.handlers.loan_transactions_get_all","summary":"Get transactions","securityGroups":[{"oauth2":["transaction:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collection of Transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionsPaging"}},"schemaId":"components/schemas/TransactionsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.loan_transactions_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions"},{"label":"Create transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_create","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_create","metadata":{"seo":{"title":"Create transaction","description":"Create a transaction. Permissions required depend on the object type passed:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transactions_create","name":"Create transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a transaction. Permissions required depend on the object type passed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One Time Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction:create.onetimepayment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction:create.servicecredit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Down Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction:create.downpayment"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a loan has been onboarded to Peach's platform, valid loan statuses for each transaction type are as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid loan statuses"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One Time Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Down Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only valid when the loan type configuration "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAllowedWhenChargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During migration while a loan is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", valid loan statuses for each transaction type are as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid loan statuses"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One Time Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Down Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransaction"}},"schemaId":"components/schemas/CreateTransaction","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTransaction"}},"responseCodes":["201","408","423"],"pointer":"/people/{personId}/loans/{loanId}/transactions","href":"transactions/peach.transactions.handlers.transactions_create","openApiOperationId":"peach.transactions.handlers.transactions_create","summary":"Create transaction","securityGroups":[{"oauth2":["transaction:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CreateTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}},"schemaId":"schema_5771"},{"code":"408","description":"Request Timeout"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5771","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}}},{"code":"408"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transactions_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions"},{"label":"Fail multiple transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_fail_multiple","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_fail_multiple","metadata":{"seo":{"title":"Fail multiple transactions","description":"This endpoint allows you to fail multiple transactions in one call. The system will mark applicable transactions asfailed and replay the loan once (starting from the earliest effective date of the provided transactions)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transactions_fail_multiple","name":"Fail multiple transactions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1fail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fail multiple transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to fail multiple transactions in one call. The system will mark applicable transactions as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and replay the loan once (starting from the earliest effective date of the provided transactions)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1fail/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1fail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5855"}},"schemaId":"schema_5855","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1fail/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions/fail","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5855"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions/fail","href":"transactions/peach.transactions.handlers.transactions_fail_multiple","openApiOperationId":"peach.transactions.handlers.transactions_fail_multiple","summary":"Fail multiple transactions","securityGroups":[{"oauth2":["transaction:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5855","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5855"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Succeeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1fail/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transactions_fail_multiple"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/fail"},{"label":"Get transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_get_by_id","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_get_by_id","metadata":{"seo":{"title":"Get transaction by ID","description":"Get transaction by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transactions_get_by_id","name":"Get transaction by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","href":"transactions/peach.transactions.handlers.transactions_get_by_id","openApiOperationId":"peach.transactions.handlers.transactions_get_by_id","summary":"Get transaction by ID","securityGroups":[{"oauth2":["transaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}},"schemaId":"schema_5771"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5771","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transactions_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}"},{"label":"Update transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_update","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_update","metadata":{"seo":{"title":"Update transaction","description":"Update transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transactions_update","name":"Update transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionUpdateExternal"}},"schemaId":"components/schemas/TransactionUpdateExternal","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionUpdateExternal"}},"responseCodes":["200","408"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","href":"transactions/peach.transactions.handlers.transactions_update","openApiOperationId":"peach.transactions.handlers.transactions_update","summary":"Update transaction","securityGroups":[{"oauth2":["transaction:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TransactionUpdateExternal","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionUpdateExternal"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}},"schemaId":"schema_5771"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5771","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transactions_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}"},{"label":"Backdate transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_backdate","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_backdate","metadata":{"seo":{"title":"Backdate transaction","description":"Backdate a transaction. Can only be applied to transactions with status=succeeded or status=pending. Can be applied to payments or service credits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transaction_backdate","name":"Backdate transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1backdate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Backdate transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backdate a transaction. Can only be applied to transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Can be applied to payments or service credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:backdate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1backdate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1backdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5856"}},"schemaId":"schema_5856","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1backdate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/backdate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:backdate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5856"}},"responseCodes":["200","408","423"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/backdate","href":"transactions/peach.transactions.handlers.transaction_backdate","openApiOperationId":"peach.transactions.handlers.transaction_backdate","summary":"Backdate transaction","securityGroups":[{"oauth2":["transaction:backdate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5856","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5856"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backdated"},{"code":"408","description":"Request Timeout"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1backdate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"408"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transaction_backdate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/backdate"},{"label":"Cancel transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_cancel","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_cancel","metadata":{"seo":{"title":"Cancel transaction","description":"Cancel transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transaction_cancel","name":"Cancel transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:cancel"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cancelReason","in":"query","schemaId":"schema_5857"},{"name":"clearExternalId","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will clear the external ID for the object."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/cancel","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"cancelReason","in":"query","required":false,"schemaId":"components/schemas/TransactionCancelReason"},{"name":"clearExternalId","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:cancel"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/cancel","href":"transactions/peach.transactions.handlers.transaction_cancel","openApiOperationId":"peach.transactions.handlers.transaction_cancel","summary":"Cancel transaction","securityGroups":[{"oauth2":["transaction:cancel"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"canceled"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1cancel/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transaction_cancel"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/cancel"},{"label":"Get transaction chargebacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargebacks","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargebacks","metadata":{"seo":{"title":"Get transaction chargebacks","description":"Get transaction chargebacks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.chargebacks.handlers.get_chargebacks","name":"Get transaction chargebacks","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction chargebacks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","href":"transactions/peach.transactions.chargebacks.handlers.get_chargebacks","openApiOperationId":"peach.transactions.chargebacks.handlers.get_chargebacks","summary":"Get transaction chargebacks","securityGroups":[{"oauth2":["transaction:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Chargebacks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5858"}},"schemaId":"schema_5858"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5858","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5858"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.chargebacks.handlers.get_chargebacks"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks"},{"label":"Create transaction chargeback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","metadata":{"seo":{"title":"Create transaction chargeback","description":"In some cases a borrower might chargeback/dispute a payment that they made in the past. Only transactions in succeeded status can be charged back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.chargebacks.handlers.transaction_chargeback","name":"Create transaction chargeback","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create transaction chargeback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases a borrower might chargeback/dispute a payment that they made in the past. Only transactions in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status can be charged back."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment/transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the caller can post chargeback in two ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update status of the transaction to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly. The chargeback amount defaults to the full amount of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will create a chargeback object automatically. This option is the easiest way to tell the system about a chargeback."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create chargeback(s) via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create transaction chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. This option allows the caller to provide more details about the chargeback."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option should be used for multiple partial chargebacks. Keep in mind that a transaction can have multiple chargebacks and reversals."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's important to not mix the options above because it can create edge cases and confusion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment/transaction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the caller cannot change the transaction status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor create chargeback(s)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create transaction chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Chargebacks will be received directly from the payment processor."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:chargeback"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5859"}},"schemaId":"schema_5859","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:chargeback"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5859"}},"responseCodes":["201","408"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","href":"transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","openApiOperationId":"peach.transactions.chargebacks.handlers.transaction_chargeback","summary":"Create transaction chargeback","securityGroups":[{"oauth2":["transaction:chargeback"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5859","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5859"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Chargeback","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}},"schemaId":"schema_5860"},{"code":"408","description":"Request Timeout"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}}},{"code":"408"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks"},{"label":"Get chargeback by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","metadata":{"seo":{"title":"Get chargeback by ID","description":"Get chargeback by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.chargebacks.handlers.get_chargeback_by_id","name":"Get chargeback by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get chargeback by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true},{"name":"chargebackId","in":"path","schemaId":"schema_5625","description":"Chargeback ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"chargebackId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","href":"transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","openApiOperationId":"peach.transactions.chargebacks.handlers.get_chargeback_by_id","summary":"Get chargeback by ID","securityGroups":[{"oauth2":["transaction:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Chargeback","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}},"schemaId":"schema_5860"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}"},{"label":"Update chargeback","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.update_chargeback","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.update_chargeback","metadata":{"seo":{"title":"Update chargeback","description":"Update chargeback"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.chargebacks.handlers.update_chargeback","name":"Update chargeback","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update chargeback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:chargeback"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true},{"name":"chargebackId","in":"path","schemaId":"schema_5625","description":"Chargeback ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Chargeback"}},"schemaId":"components/schemas/Chargeback","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"chargebackId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:chargeback"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Chargeback"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","href":"transactions/peach.transactions.chargebacks.handlers.update_chargeback","openApiOperationId":"peach.transactions.chargebacks.handlers.update_chargeback","summary":"Update chargeback","securityGroups":[{"oauth2":["transaction:chargeback"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Chargeback","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Chargeback"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Chargeback","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}},"schemaId":"schema_5860"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1chargebacks~1{chargebackId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5860","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5860"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.chargebacks.handlers.update_chargeback"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}"},{"label":"Reverse transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_reverse","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_reverse","metadata":{"seo":{"title":"Reverse transaction","description":"Reverse transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.transactions.handlers.transaction_reverse","name":"Reverse transaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1reverse/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["transaction:reverse"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_5625","description":"Transaction ID. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1reverse/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1reverse/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5861"}},"schemaId":"schema_5861","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1reverse/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/reverse","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["transaction:reverse"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5861"}},"responseCodes":["201","408","423"],"pointer":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/reverse","href":"transactions/peach.transactions.handlers.transaction_reverse","openApiOperationId":"peach.transactions.handlers.transaction_reverse","summary":"Reverse transaction","securityGroups":[{"oauth2":["transaction:reverse"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5861","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5861"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A Transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}},"schemaId":"schema_5771"},{"code":"408","description":"Request Timeout"},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}},"schemaId":"schema_5776"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1transactions~1{transactionId}~1reverse/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5771","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5771"}}},{"code":"408"},{"code":"423","schemaId":"schema_5776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5776"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/peach.transactions.handlers.transaction_reverse"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/reverse"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"This object represents payments and credits. Payments represent real money that were paid back by borrowers. Credits\nare adjustments made on a loan. Credits lower balances similar to payments. Credits can be issued by customer service\nrepresentatives or supervisors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/transactions","summary":"Get transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/peach.transactions.handlers.loan_transactions_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions","summary":"Create transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.handlers.transactions_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/fail","summary":"Fail multiple transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.handlers.transactions_fail_multiple","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","summary":"Get transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/peach.transactions.handlers.transactions_get_by_id","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","summary":"Update transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transactions/peach.transactions.handlers.transactions_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/backdate","summary":"Backdate transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.handlers.transaction_backdate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/cancel","summary":"Cancel transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.handlers.transaction_cancel","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","summary":"Get transaction chargebacks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/peach.transactions.chargebacks.handlers.get_chargebacks","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","summary":"Create transaction chargeback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","summary":"Get chargeback by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","summary":"Update chargeback","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transactions/peach.transactions.chargebacks.handlers.update_chargeback","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/reverse","summary":"Reverse transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/peach.transactions.handlers.transaction_reverse","deprecated":false}]}]}]}]}},{"type":"group","label":"Statements","link":"/api-docs/api-public/statements","routeSlug":"/api-docs/api-public/statements","items":[{"label":"Generate statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.generate_statement","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.generate_statement","metadata":{"seo":{"title":"Generate statement","description":"Generates a statement, and if one already exists, replaces the older one as the active one.If sync=true is passed, the server will try to wait up to 20 seconds for the statementcreation to finish. If it finishes in time, it will return the statement object.Otherwise, it will return nothing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.statements.handlers.generate_statement","name":"Generate statement","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{periodId}~1generate-statement/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a statement, and if one already exists, replaces the older one as the active one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the server will try to wait up to 20 seconds for the statement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation to finish. If it finishes in time, it will return the statement object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, it will return nothing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["statement:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"periodId","in":"path","schemaId":"components/schemas/newStatus","description":"The identifier of the period.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{periodId}~1generate-statement/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sync","in":"query","schemaId":"schema_5623","description":"Make the process synchronous."},{"name":"sendNotice","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementGenerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}]},{"name":"reason","in":"query","schemaId":"components/schemas/newStatus","description":"Reason for manually generating statement."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{periodId}~1generate-statement/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"periodId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"sync","in":"query","schemaId":"schema_5623"},{"name":"sendNotice","in":"query","schemaId":"schema_5623"},{"name":"reason","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["statement:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["201"],"pointer":"/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement","href":"statements/peach.statements.handlers.generate_statement","openApiOperationId":"peach.statements.handlers.generate_statement","summary":"Generate statement","securityGroups":[{"oauth2":["statement:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5862"}},"schemaId":"schema_5862"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1periods~1{periodId}~1generate-statement/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5862","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5862"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/peach.statements.handlers.generate_statement"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement"},{"label":"Get statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.get_statements","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.get_statements","metadata":{"seo":{"title":"Get statements","description":"Get statements"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.statements.handlers.get_statements","name":"Get statements","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["statement:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"year","in":"query","schemaId":"components/schemas/newStatus","description":"Only return statements from the current year."},{"name":"includeAllVersions","in":"query","schemaId":"schema_5623","description":"A flag to determine if all template versions should be returned, not just the most recent / active ones.\n"},{"name":"includeTestVersions","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flag to determine whether test versions should be returned. If this flag is set to \"true\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will ignore the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeAllVersions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute and return only test versions."},"children":[]}]}]}]},{"name":"documentDescriptorIds","in":"query","schemaId":"schema_5694","description":"List of document descriptor IDs to filter by"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/statements","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"year","in":"query","schemaId":"components/schemas/newStatus"},{"name":"includeAllVersions","in":"query","schemaId":"schema_5623"},{"name":"includeTestVersions","in":"query","schemaId":"schema_5623"},{"name":"documentDescriptorIds","in":"query","required":false,"schemaId":"schema_5694"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["statement:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/statements","href":"statements/peach.statements.handlers.get_statements","openApiOperationId":"peach.statements.handlers.get_statements","summary":"Get statements","securityGroups":[{"oauth2":["statement:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collection of statements","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementsPaging"}},"schemaId":"components/schemas/StatementsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/peach.statements.handlers.get_statements"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/statements"},{"label":"Update statement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.update_statement","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.update_statement","metadata":{"seo":{"title":"Update statement","description":"Update statement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.statements.handlers.update_statement","name":"Update statement","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["statement:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"statementId","in":"path","schemaId":"schema_5863","description":"The statement object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5864"}},"schemaId":"schema_5864","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/statements/{statementId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"statementId","in":"path","required":true,"schemaId":"schema_5863"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["statement:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5864"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/statements/{statementId}","href":"statements/peach.statements.handlers.update_statement","openApiOperationId":"peach.statements.handlers.update_statement","summary":"Update statement","securityGroups":[{"oauth2":["statement:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5864","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5864"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single Statement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5865"}},"schemaId":"schema_5865"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5865","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5865"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/peach.statements.handlers.update_statement"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/statements/{statementId}"},{"label":"Get statement details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.get_statement_details","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.get_statement_details","metadata":{"seo":{"title":"Get statement details","description":"Get statement details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.statements.handlers.get_statement_details","name":"Get statement details","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statement details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["statement:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"statementId","in":"path","schemaId":"schema_5863","description":"The statement object unique identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/statements/{statementId}/details","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"statementId","in":"path","required":true,"schemaId":"schema_5863"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["statement:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/statements/{statementId}/details","href":"statements/peach.statements.handlers.get_statement_details","openApiOperationId":"peach.statements.handlers.get_statement_details","summary":"Get statement details","securityGroups":[{"oauth2":["statement:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details for a single statement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5866"}},"schemaId":"schema_5866"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1statements~1{statementId}~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5866","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5866"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/peach.statements.handlers.get_statement_details"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/statements/{statementId}/details"}],"content":{"contentType":"group","meta":{"name":"Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statements","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents line of credit (e.g. credit card) or loan (e.g. personal installment) statement. Each statement is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with one due date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit, statements are created one calendar day after the period end date. The number of dates between a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statement creation and a due date can be configured by lenders, but are normally 14 or 21 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For installments, there are two options for when statements can be created:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One calendar day after the period end date, which is also the due date. In this case, the statement date and due date are the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of calendar days before the period end date. The offset (as number of calendar days) can be configured by lenders."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, a statement is created and sent before the period ends, which means some of the statement details are calculated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on partial period data (e.g. amount of interest accrued in the period.)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement","summary":"Generate statement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/peach.statements.handlers.generate_statement","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/statements","summary":"Get statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/peach.statements.handlers.get_statements","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/statements/{statementId}","summary":"Update statement","prefix":{"name":"put","color":"put"},"badges":[],"link":"/statements/peach.statements.handlers.update_statement","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/statements/{statementId}/details","summary":"Get statement details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/peach.statements.handlers.get_statement_details","deprecated":false}]}]}]}]}},{"type":"group","label":"Autopay","link":"/api-docs/api-public/autopay","routeSlug":"/api-docs/api-public/autopay","items":[{"label":"Cancel Autopay plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","metadata":{"seo":{"title":"Cancel Autopay plan","description":"Cancel Autopay plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.autopay.handlers.loan_autopay_delete","name":"Cancel Autopay plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Autopay plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["autopay:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cancellationReason","in":"query","schemaId":"schema_5867","description":"The cancellation reason.\n"},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"The case object unique identifier."},{"name":"sendNotice","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/autopay","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"cancellationReason","in":"query","required":false,"schemaId":"schema_5867"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/AnyId"},{"name":"sendNotice","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["autopay:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/autopay","href":"autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","openApiOperationId":"peach.people.loans.autopay.handlers.loan_autopay_delete","summary":"Cancel Autopay plan","securityGroups":[{"oauth2":["autopay:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/autopay"},{"label":"Get Autopay plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_get","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_get","metadata":{"seo":{"title":"Get Autopay plan","description":"Get Autopay plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.autopay.handlers.loan_autopay_get","name":"Get Autopay plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Autopay plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["autopay:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"statuses","in":"query","schemaId":"schema_5868","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The comma separated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values of autopay expected payments to include in the results, which are merged by date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All autopay expected payments can still be accessed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individualEntries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/autopay","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"statuses","in":"query","schemaId":"schema_5868","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["autopay:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/autopay","href":"autopay/peach.people.loans.autopay.handlers.loan_autopay_get","openApiOperationId":"peach.people.loans.autopay.handlers.loan_autopay_get","summary":"Get Autopay plan","securityGroups":[{"oauth2":["autopay:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5869"}},"schemaId":"schema_5869"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5869","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5869"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/autopay"},{"label":"Create Autopay plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_post","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_post","metadata":{"seo":{"title":"Create Autopay plan","description":"Create Autopay plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.autopay.handlers.loan_autopay_post","name":"Create Autopay plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Autopay plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["autopay:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutopayPost"}},"schemaId":"components/schemas/AutopayPost","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/autopay","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["autopay:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AutopayPost"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/autopay","href":"autopay/peach.people.loans.autopay.handlers.loan_autopay_post","openApiOperationId":"peach.people.loans.autopay.handlers.loan_autopay_post","summary":"Create Autopay plan","securityGroups":[{"oauth2":["autopay:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AutopayPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutopayPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5870"}},"schemaId":"schema_5870"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5870","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5870"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_post"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/autopay"},{"label":"Update Autopay plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_put","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_put","metadata":{"seo":{"title":"Update Autopay plan","description":"Update Autopay plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.autopay.handlers.loan_autopay_put","name":"Update Autopay plan","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Autopay plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["autopay:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutopayUpdate"}},"schemaId":"components/schemas/AutopayUpdate","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/autopay","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["autopay:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AutopayUpdate"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/autopay","href":"autopay/peach.people.loans.autopay.handlers.loan_autopay_put","openApiOperationId":"peach.people.loans.autopay.handlers.loan_autopay_put","summary":"Update Autopay plan","securityGroups":[{"oauth2":["autopay:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AutopayUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutopayUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5870"}},"schemaId":"schema_5870"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1autopay/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5870","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5870"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_put"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/autopay"}],"content":{"contentType":"group","meta":{"name":"Autopay"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Autopay","showPageActions":true},{"nodeType":"markdoc","content":"This object represents the current Autopay plan. The current Autopay plan must be canceled before creating a new plan. The autopay\ncadence can be aligned to due dates or can be on a different payment schedule."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/autopay","summary":"Cancel Autopay plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/autopay","summary":"Get Autopay plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/autopay","summary":"Create Autopay plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_post","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/autopay","summary":"Update Autopay plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/autopay/peach.people.loans.autopay.handlers.loan_autopay_put","deprecated":false}]}]}]}]}},{"type":"group","label":"Balances","link":"/api-docs/api-public/balances","routeSlug":"/api-docs/api-public/balances","items":[{"label":"Get loan balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_balances_get","metadata":{"seo":{"title":"Get loan balances","description":"Get loan balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.balances.handlers.loan_balances_get","name":"Get loan balances","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1balances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, balances will be rounded to the closes 1 cent."},{"name":"skipYtd","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, skip year-to-date calculations."},{"name":"fast","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform a faster query that returns a pre-defined subset of attributes. When this query parameter is used, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toEffectiveAt"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter is ignored and only real-time balances are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To configure the subset of attributes, please contact the Peach team."},"children":[]}]}]}]},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which to fetch balances"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"skipYtd","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"fast","in":"query","schemaId":"schema_5623"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/balances","href":"balances/peach.people.loans.balances.handlers.loan_balances_get","openApiOperationId":"peach.people.loans.balances.handlers.loan_balances_get","summary":"Get loan balances","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5871"}},"schemaId":"schema_5871"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5871","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5871"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/peach.people.loans.balances.handlers.loan_balances_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/balances"},{"label":"Get draw balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_balances_get","metadata":{"seo":{"title":"Get draw balances","description":"Get draw balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.balances.handlers.draw_balances_get","name":"Get draw balances","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1balances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, balances will be rounded to the closes 1 cent."},{"name":"skipYtd","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, skip year-to-date calculations."},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which to fetch balances"},{"name":"skipInterestAccrual","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, skip automatic interest accrual to catch up if it is missing."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"skipYtd","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"skipInterestAccrual","in":"query","schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/balances","href":"balances/peach.people.loans.balances.handlers.draw_balances_get","openApiOperationId":"peach.people.loans.balances.handlers.draw_balances_get","summary":"Get draw balances","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5871"}},"schemaId":"schema_5871"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5871","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5871"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/peach.people.loans.balances.handlers.draw_balances_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/balances"},{"label":"Get draw future balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_future_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_future_balances_get","metadata":{"seo":{"title":"Get draw future balances","description":"Get draw future balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.balances.handlers.draw_future_balances_get","name":"Get draw future balances","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1future-balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get draw future balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1future-balances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, balances will be rounded to the closes 1 cent."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1future-balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances","href":"balances/peach.people.loans.balances.handlers.draw_future_balances_get","openApiOperationId":"peach.people.loans.balances.handlers.draw_future_balances_get","summary":"Get draw future balances","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5872"}},"schemaId":"schema_5872"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1future-balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5872","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5872"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/peach.people.loans.balances.handlers.draw_future_balances_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances"},{"label":"Get loan future balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_future_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_future_balances_get","metadata":{"seo":{"title":"Get loan future balances","description":"Get loan future balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.balances.handlers.loan_future_balances_get","name":"Get loan future balances","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1future-balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan future balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1future-balances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"If true, balances will be rounded to the closes 1 cent."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1future-balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/future-balances","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"isRounded","in":"query","schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/future-balances","href":"balances/peach.people.loans.balances.handlers.loan_future_balances_get","openApiOperationId":"peach.people.loans.balances.handlers.loan_future_balances_get","summary":"Get loan future balances","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5872"}},"schemaId":"schema_5872"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1future-balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5872","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5872"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/peach.people.loans.balances.handlers.loan_future_balances_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/future-balances"},{"label":"Get loan interest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_interest_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_interest_get","metadata":{"seo":{"title":"Get loan interest","description":"Get loan interest"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_interest_get","name":"Get loan interest","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1interest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan interest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.interest:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1interest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"drawId","in":"query","schemaId":"schema_5625","description":"The draw identifier, if getting interest for a specific draw."},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which to fetch balances"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Last day for which to fetch balances"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1interest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/interest","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"drawId","in":"query","required":false,"schemaId":"components/schemas/AnyId"},{"name":"fromEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"toEffectiveDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.interest:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/interest","href":"balances/peach.people.loans.handlers.loan_interest_get","openApiOperationId":"peach.people.loans.handlers.loan_interest_get","summary":"Get loan interest","securityGroups":[{"oauth2":["loan.interest:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5873"}},"schemaId":"schema_5873"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1interest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5873"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/peach.people.loans.handlers.loan_interest_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/interest"}],"content":{"contentType":"group","meta":{"name":"Balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":"This object represents current loan balances."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/balances","summary":"Get loan balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/peach.people.loans.balances.handlers.loan_balances_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/balances","summary":"Get draw balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/peach.people.loans.balances.handlers.draw_balances_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances","summary":"Get draw future balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/peach.people.loans.balances.handlers.draw_future_balances_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/future-balances","summary":"Get loan future balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/peach.people.loans.balances.handlers.loan_future_balances_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/interest","summary":"Get loan interest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/peach.people.loans.handlers.loan_interest_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit Reporting","link":"/api-docs/api-public/credit-reporting","routeSlug":"/api-docs/api-public/credit-reporting","items":[{"label":"Get credit reporting statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","metadata":{"seo":{"title":"Get credit reporting statuses","description":"Get credit reporting statuses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_reporting_statuses_list","name":"Get credit reporting statuses","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get credit reporting statuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.reporting.status:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/credit-reporting","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.reporting.status:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-reporting","href":"credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","openApiOperationId":"peach.credit_reporting.handlers.credit_reporting_statuses_list","summary":"Get credit reporting statuses","securityGroups":[{"oauth2":["credit.reporting.status:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5874"}},"schemaId":"schema_5874"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5874","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5874"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting"},{"label":"Start credit reporting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","metadata":{"seo":{"title":"Start credit reporting","description":"Sets the starting date to begin reporting credit history for the loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_reporting_status_create","name":"Start credit reporting","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start credit reporting","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets the starting date to begin reporting credit history for the loan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.reporting.status:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5875"}},"schemaId":"schema_5875","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/credit-reporting","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.reporting.status:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5875"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-reporting","href":"credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","openApiOperationId":"peach.credit_reporting.handlers.credit_reporting_status_create","summary":"Start credit reporting","securityGroups":[{"oauth2":["credit.reporting.status:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5875","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5875"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5876"}},"schemaId":"schema_5876"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5876","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5876"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting"},{"label":"Update reporting fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","metadata":{"seo":{"title":"Update reporting fields","description":"Sets loan-level credit reporting fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_reporting_fields_update","name":"Update reporting fields","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update reporting fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets loan-level credit reporting fields"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCreditReportingFields"}},"schemaId":"components/schemas/LoanCreditReportingFields","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/credit-reporting","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanCreditReportingFields"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-reporting","href":"credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","openApiOperationId":"peach.credit_reporting.handlers.credit_reporting_fields_update","summary":"Update reporting fields","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanCreditReportingFields","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanCreditReportingFields"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}},"schemaId":"schema_5761"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5761"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting"},{"label":"Delete from credit reporting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","metadata":{"seo":{"title":"Delete from credit reporting","description":"Delete from credit reporting"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_reporting_status_delete","name":"Delete from credit reporting","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting~1{creditAgencyId}~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete from credit reporting","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.reporting.status:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"creditAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the credit agency","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting~1{creditAgencyId}~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5877"}},"schemaId":"schema_5877","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting~1{creditAgencyId}~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"creditAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.reporting.status:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5877"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete","href":"credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","openApiOperationId":"peach.credit_reporting.handlers.credit_reporting_status_delete","summary":"Delete from credit reporting","securityGroups":[{"oauth2":["credit.reporting.status:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5876"}},"schemaId":"schema_5876"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1credit-reporting~1{creditAgencyId}~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5876","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5876"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete"}],"content":{"contentType":"group","meta":{"name":"Credit Reporting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Reporting","showPageActions":true},{"nodeType":"markdoc","content":"This object represents loan credit reporting data as it was reported to credit bureaus."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/credit-reporting","summary":"Get credit reporting statuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/credit-reporting","summary":"Start credit reporting","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/credit-reporting","summary":"Update reporting fields","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete","summary":"Delete from credit reporting","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Loan Investors","link":"/api-docs/api-public/loansinvestors","routeSlug":"/api-docs/api-public/loansinvestors","items":[{"label":"Get loan investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_get_all","routeSlug":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_get_all","metadata":{"seo":{"title":"Get loan investors","description":"Get loan investors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_investors_get_all","name":"Get loan investors","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan investors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/investors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/investors","href":"loansinvestors/peach.people.loans.handlers.loan_investors_get_all","openApiOperationId":"peach.people.loans.handlers.loan_investors_get_all","summary":"Get loan investors","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanInvestorsPaging"}},"schemaId":"components/schemas/LoanInvestorsPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LoanInvestorsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanInvestorsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loansinvestors/peach.people.loans.handlers.loan_investors_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/investors"},{"label":"Update loan investors","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_update","routeSlug":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_update","metadata":{"seo":{"title":"Update loan investors","description":"Update loan investors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.loan_investors_update","name":"Update loan investors","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan investors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.investors:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanInvestors"}},"schemaId":"components/schemas/LoanInvestors","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/investors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.investors:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanInvestors"}},"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/investors","href":"loansinvestors/peach.people.loans.handlers.loan_investors_update","openApiOperationId":"peach.people.loans.handlers.loan_investors_update","summary":"Update loan investors","securityGroups":[{"oauth2":["loan.investors:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanInvestors","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanInvestors"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"updated"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1investors/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loansinvestors/peach.people.loans.handlers.loan_investors_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/investors"}],"content":{"contentType":"group","meta":{"name":"LoansInvestors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Investors","showPageActions":true},{"nodeType":"markdoc","content":"Investors associated with a loan."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/investors","summary":"Get loan investors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loansinvestors/peach.people.loans.handlers.loan_investors_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/investors","summary":"Update loan investors","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loansinvestors/peach.people.loans.handlers.loan_investors_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Loan Collection Agencies","link":"/api-docs/api-public/loan-collection-agencies","routeSlug":"/api-docs/api-public/loan-collection-agencies","items":[{"label":"Unassign loan collection agency","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","metadata":{"seo":{"title":"Unassign loan collection agency","description":"This endpoint is used to \"unassign\" a loan from a collection agency. To keep the servicedBy value on the loan to debtCollectionAgency,just pass that value to this endpoint and the servicedBy will remain the same, while still clearing the collection agency assignment fields for the loan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_loan_details_unassign","name":"Unassign loan collection agency","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unassign loan collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to \"unassign\" a loan from a collection agency. To keep the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value on the loan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtCollectionAgency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"just pass that value to this endpoint and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remain the same, while still clearing the collection agency assignment fields for the loan."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"servicedBy","in":"query","schemaId":"schema_5878","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/collection-agency","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"servicedBy","in":"query","required":true,"schemaId":"components/schemas/LoanServicer"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/collection-agency","href":"loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","openApiOperationId":"peach.collections.handlers.collection_agency_loan_details_unassign","summary":"Unassign loan collection agency","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}},"schemaId":"schema_5879"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5879","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency"},{"label":"Get loan collection agency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","metadata":{"seo":{"title":"Get loan collection agency","description":"Get loan collection agency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_loan_details_get","name":"Get loan collection agency","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/collection-agency","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/collection-agency","href":"loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","openApiOperationId":"peach.collections.handlers.collection_agency_loan_details_get","summary":"Get loan collection agency","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}},"schemaId":"schema_5879"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5879","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency"},{"label":"Update loan collection agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","metadata":{"seo":{"title":"Update loan collection agency","description":"This end point allows lenders to assign a loan to a debt collection agency.When a loan is assigned to a debt collection agency, the system will set servicedBy=debtCollectionAgency.Once the loan is assigned, Peach system can only accept \"external\" transactions to update the loan balance (isExternal=true)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_loan_details_update","name":"Update loan collection agency","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This end point allows lenders to assign a loan to a debt collection agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a loan is assigned to a debt collection agency, the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicedBy=debtCollectionAgency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the loan is assigned, Peach system can only accept \"external\" transactions to update the loan balance ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionAgencyLoanDetailsPut"}},"schemaId":"components/schemas/CollectionAgencyLoanDetailsPut","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/collection-agency","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionAgencyLoanDetailsPut"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/collection-agency","href":"loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","openApiOperationId":"peach.collections.handlers.collection_agency_loan_details_update","summary":"Update loan collection agency","securityGroups":[{"oauth2":["loan:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CollectionAgencyLoanDetailsPut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionAgencyLoanDetailsPut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}},"schemaId":"schema_5879"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1collection-agency/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5879","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5879"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency"}],"content":{"contentType":"group","meta":{"name":"Loan Collection Agencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Collection Agencies","showPageActions":true},{"nodeType":"markdoc","content":"Allows a loan to be assigned to a collection agency"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/collection-agency","summary":"Unassign loan collection agency","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/collection-agency","summary":"Get loan collection agency","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/collection-agency","summary":"Update loan collection agency","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Promo Programs","link":"/api-docs/api-public/promo-programs","routeSlug":"/api-docs/api-public/promo-programs","items":[{"label":"Create promo program for draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","metadata":{"seo":{"title":"Create promo program for draw","description":"Create promo program for draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_add","name":"Create promo program for draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create promo program for draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"schemaId":"components/schemas/PromoProgramPost","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_add","summary":"Create promo program for draw","securityGroups":[{"oauth2":["loan.promoprogram:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs"},{"label":"Cancel promo program for draw","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","metadata":{"seo":{"title":"Cancel promo program for draw","description":"Cancel promo program for draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","name":"Cancel promo program for draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel promo program for draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"promoCancelReason","in":"query","schemaId":"schema_5881","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo was disqualified for various"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerOptedOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the borrower decided to opt out from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adminError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo program was added by mistake."},"children":[]}]}]}]},{"name":"sendNotice","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the system will send a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramCanceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}]},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"The case object unique identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"promoCancelReason","in":"query","required":false,"schemaId":"components/schemas/PromoCancelReason"},{"name":"sendNotice","in":"query","required":false,"schemaId":"schema_5644"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","summary":"Cancel promo program for draw","securityGroups":[{"oauth2":["loan.promoprogram:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5882"}},"schemaId":"schema_5882"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5882","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5882"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}"},{"label":"Get promo program for draw by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","metadata":{"seo":{"title":"Get promo program for draw by ID","description":"Get promo program for draw by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_get","name":"Get promo program for draw by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get promo program for draw by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_get","summary":"Get promo program for draw by ID","securityGroups":[{"oauth2":["loan.promoprogram:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}"},{"label":"Update promo program for draw","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","metadata":{"seo":{"title":"Update promo program for draw","description":"There a few restrictions on what can be updated.promoTypeId cannot be updated.If status=pending - any attribute except for status can beupdated.To activate use the Activate promo program endpoint.If status=active - promoType, status, promoDurationDaysand promoStartDate cannot be updated.If status=canceled -  promoType, promoDurationDays andpromoStartDate cannot be updated.If status=exercised - no attributes can be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_update","name":"Update promo program for draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update promo program for draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There a few restrictions on what can be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - any attribute except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To activate use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate promo program"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no attributes can be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPutCommon"}},"schemaId":"components/schemas/PromoProgramPutCommon","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramPutCommon"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_update","summary":"Update promo program for draw","securityGroups":[{"oauth2":["loan.promoprogram:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramPutCommon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPutCommon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}"},{"label":"Activate promo program for draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","metadata":{"seo":{"title":"Activate promo program for draw","description":"Activate promo program for draw"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","name":"Activate promo program for draw","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate promo program for draw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:activate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"drawId","in":"path","schemaId":"schema_5625","description":"The draw identifier.","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}/activate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"drawId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:activate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}/activate","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","summary":"Activate promo program for draw","securityGroups":[{"oauth2":["loan.promoprogram:activate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1draws~1{drawId}~1promo-programs~1{promoProgramId}~1activate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}/activate"},{"label":"Get promo programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","metadata":{"seo":{"title":"Get promo programs","description":"Get promo programs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_get_all","name":"Get promo programs","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get promo programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"promoEffectiveEndDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return promo programs with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEffectiveEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starting after the provided date."},"children":[]}]}]}]},{"name":"statuses","in":"query","schemaId":"schema_5883","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The array of statuses used for filtering if a borrower has promo programs with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"passed, by default we return all statuses"},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/promo-programs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"promoEffectiveEndDateAfter","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"statuses","in":"query","schemaId":"schema_5883"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_get_all","summary":"Get promo programs","securityGroups":[{"oauth2":["loan.promoprogram:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PromoProgramPaging"}},"schemaId":"components/schemas/PromoProgramPaging"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PromoProgramPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PromoProgramPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs"},{"label":"Create promo program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","metadata":{"seo":{"title":"Create promo program","description":"Create promo program"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_add","name":"Create promo program","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create promo program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"schemaId":"components/schemas/PromoProgramPost","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/promo-programs","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_add","summary":"Create promo program","securityGroups":[{"oauth2":["loan.promoprogram:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs"},{"label":"Cancel promo program","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","metadata":{"seo":{"title":"Cancel promo program","description":"Cancel promo program"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_delete","name":"Cancel promo program","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel promo program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"promoCancelReason","in":"query","schemaId":"schema_5881","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo was disqualified for various"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerOptedOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the borrower decided to opt out from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adminError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo program was added by mistake."},"children":[]}]}]}]},{"name":"sendNotice","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the system will send a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramCanceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}]},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"The case object unique identifier."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"promoCancelReason","in":"query","required":false,"schemaId":"components/schemas/PromoCancelReason"},{"name":"sendNotice","in":"query","required":false,"schemaId":"schema_5644"},{"name":"caseId","in":"query","required":false,"schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_delete","summary":"Cancel promo program","securityGroups":[{"oauth2":["loan.promoprogram:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5882"}},"schemaId":"schema_5882"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5882","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5882"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}"},{"label":"Get promo program by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","metadata":{"seo":{"title":"Get promo program by ID","description":"Get promo program by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_get","name":"Get promo program by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get promo program by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_get","summary":"Get promo program by ID","securityGroups":[{"oauth2":["loan.promoprogram:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}"},{"label":"Update promo program","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","metadata":{"seo":{"title":"Update promo program","description":"There a few restrictions on what can be updated.promoTypeId cannot be updated.If status=pending - any attribute except for status can beupdated.To activate use the Activate promo program endpoint.If status=active - promoType, status, promoDurationDaysand promoStartDate cannot be updated.If status=canceled -  promoType, promoDurationDays andpromoStartDate cannot be updated.If status=exercised - no attributes can be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_update","name":"Update promo program","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update promo program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There a few restrictions on what can be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - any attribute except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To activate use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate promo program"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no attributes can be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPut"}},"schemaId":"components/schemas/PromoProgramPut","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramPut"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_update","summary":"Update promo program","securityGroups":[{"oauth2":["loan.promoprogram:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramPut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramPut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}},"schemaId":"schema_5880"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5880"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}"},{"label":"Activate promo program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","metadata":{"seo":{"title":"Activate promo program","description":"Activate promo program"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program.promo_programs_activate","name":"Activate promo program","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate promo program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram:activate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"promoProgramId","in":"path","schemaId":"schema_5625","description":"The promotional program identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}/activate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"promoProgramId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram:activate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}/activate","href":"promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","openApiOperationId":"peach.promo_programs.handlers.promo_program.promo_programs_activate","summary":"Activate promo program","securityGroups":[{"oauth2":["loan.promoprogram:activate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1promo-programs~1{promoProgramId}~1activate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}/activate"}],"content":{"contentType":"group","meta":{"name":"Promo Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Promo Programs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs","summary":"Create promo program for draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","summary":"Cancel promo program for draw","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","summary":"Get promo program for draw by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","summary":"Update promo program for draw","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}/activate","summary":"Activate promo program for draw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs","summary":"Get promo programs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs","summary":"Create promo program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","summary":"Cancel promo program","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","summary":"Get promo program by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","summary":"Update promo program","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}/activate","summary":"Activate promo program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","deprecated":false}]}]}]}]}},{"type":"group","label":"Cards","link":"/api-docs/api-public/cards","routeSlug":"/api-docs/api-public/cards","items":[{"label":"Get cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.cards_list","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.cards_list","metadata":{"seo":{"title":"Get cards","description":"Get cards"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.cards_list","name":"Get cards","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"showPan","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the full PAN in the response. Special permission is required."},"children":[]}]}]}]},{"name":"showCvv","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the full CVV2 number in the response. Special permission is required."},"children":[]}]}]}]},{"name":"refresh","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Peach system will make new API calls to the card issuer to get the most recent card details and balances,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will store the new details in the Peach database. Otherwise, the Peach system will return the most recent details from its database."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter cards by status. Accepts a single value or a comma-separated list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?status=blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?status=blocked,closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/cards","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"showPan","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"showCvv","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"refresh","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/newStatus","style":"form","explode":false},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/cards","href":"cards/peach.card_issuers.handlers.cards_list","openApiOperationId":"peach.card_issuers.handlers.cards_list","summary":"Get cards","securityGroups":[{"oauth2":["card:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5884"}},"schemaId":"schema_5884"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5884","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5884"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/peach.card_issuers.handlers.cards_list"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cards"},{"label":"Create card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_create","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_create","metadata":{"seo":{"title":"Create card","description":"The card details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_create","name":"Create card","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the card (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifiers.galileoCad"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") attributes or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes are passed and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will sync the card status, transactions and balances with the loan ledger seamlessly. Note: these attributes must be passed if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because Peach will need the identifying information to tie the issuer's events to the proper card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the card details will be stored in the Peach system as read-only. The lender is responsible for updating the loan details based on the card usage. Note: if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes can be updated only if the loan status is originated or pending. After the loan is activated, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" information cannot be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardWithPanAndCvv"}},"schemaId":"components/schemas/CardWithPanAndCvv","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/loans/{loanId}/cards","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardWithPanAndCvv"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/cards","href":"cards/peach.card_issuers.handlers.card_create","openApiOperationId":"peach.card_issuers.handlers.card_create","summary":"Create card","securityGroups":[{"oauth2":["card:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CardWithPanAndCvv","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardWithPanAndCvv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5885"}},"schemaId":"schema_5885"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5885","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5885"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/peach.card_issuers.handlers.card_create"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cards"},{"label":"Get card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_get","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_get","metadata":{"seo":{"title":"Get card","description":"Get card"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_get","name":"Get card","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"cardId","in":"path","schemaId":"schema_5625","description":"The ID of the card. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"showPan","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the full PAN in the response. Special permission is required."},"children":[]}]}]}]},{"name":"showCvv","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the full CVV2 number in the response. Special permission is required."},"children":[]}]}]}]},{"name":"refresh","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Peach system will make new API calls to the card issuer to get the most recent card details and balances,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will store the new details in the Peach database. Otherwise, the Peach system will return the most recent details from its database."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/loans/{loanId}/cards/{cardId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"cardId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"showPan","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"showCvv","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"refresh","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/cards/{cardId}","href":"cards/peach.card_issuers.handlers.card_get","openApiOperationId":"peach.card_issuers.handlers.card_get","summary":"Get card","securityGroups":[{"oauth2":["card:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5886"}},"schemaId":"schema_5886"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5886","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5886"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/peach.card_issuers.handlers.card_get"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cards/{cardId}"},{"label":"Update card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_update","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_update","metadata":{"seo":{"title":"Update card","description":"The card details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_update","name":"Update card","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the card (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifiers.galileoCad"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") attributes or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes are passed and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will sync the card status, transactions and balances with the loan ledger seamlessly. Note: these attributes must be passed if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because Peach will need the identifying information to tie the issuer's events to the proper card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the card details will be stored in the Peach system as read-only. The lender is responsible for updating the loan details based on the card usage. Note: if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerEventsSubscriber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes can be updated only if the loan status is originated or pending. After the loan is activated, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" information cannot be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true},{"name":"cardId","in":"path","schemaId":"schema_5625","description":"The ID of the card. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCardWithPanAndCvv"}},"schemaId":"components/schemas/PutCardWithPanAndCvv","pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/loans/{loanId}/cards/{cardId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"cardId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutCardWithPanAndCvv"}},"responseCodes":["200"],"pointer":"/people/{personId}/loans/{loanId}/cards/{cardId}","href":"cards/peach.card_issuers.handlers.card_update","openApiOperationId":"peach.card_issuers.handlers.card_update","summary":"Update card","securityGroups":[{"oauth2":["card:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PutCardWithPanAndCvv","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCardWithPanAndCvv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5885"}},"schemaId":"schema_5885"}],"pointer":"/paths/~1people~1{personId}~1loans~1{loanId}~1cards~1{cardId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5885","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5885"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/peach.card_issuers.handlers.card_update"}],"panels":[]}]},"httpPath":"/people/{personId}/loans/{loanId}/cards/{cardId}"}],"content":{"contentType":"group","meta":{"name":"Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BETA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows lenders to associate physical or virtual card with a loan or line of credit."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/loans/{loanId}/cards","summary":"Get cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cards/peach.card_issuers.handlers.cards_list","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/cards","summary":"Create card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cards/peach.card_issuers.handlers.card_create","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/cards/{cardId}","summary":"Get card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cards/peach.card_issuers.handlers.card_get","deprecated":false},{"title":"/people/{personId}/loans/{loanId}/cards/{cardId}","summary":"Update card","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cards/peach.card_issuers.handlers.card_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Loan Labels","link":"/api-docs/api-public/loan-labels","routeSlug":"/api-docs/api-public/loan-labels","items":[{"label":"Get loan labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_list","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_list","metadata":{"seo":{"title":"Get loan labels","description":"Get loan labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_labels_list","name":"Get loan labels","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"createdBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns loan labels created before a specific timestamp. If used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a time range can be created to return labels created between two timestamps."},"children":[]}]}]}]},{"name":"createdAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns loan labels created before a specific timestamp. If used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a time range can be created to return labels created between two timestamps."},"children":[]}]}]}]},{"name":"loanId","in":"query","schemaId":"schema_5625","description":"Filter by Loan's unique identifier. Can be Peach or lender's external identifier.\n"},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-labels","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"createdBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"loanId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-labels","href":"loan-labels/peach.loans.labels.handlers.loan_labels_list","openApiOperationId":"peach.loans.labels.handlers.loan_labels_list","summary":"Get loan labels","securityGroups":[{"oauth2":["loan.label:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5887"}},"schemaId":"schema_5887"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5887","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5887"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_labels_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels"},{"label":"Create loan label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_create","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_create","metadata":{"seo":{"title":"Create loan label","description":"Creates a new loan label."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_label_create","name":"Create loan label","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create loan label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new loan label."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5888"}},"schemaId":"schema_5888","pointer":"/paths/~1companies~1{companyId}~1loan-labels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/loan-labels","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5888"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-labels","href":"loan-labels/peach.loans.labels.handlers.loan_label_create","openApiOperationId":"peach.loans.labels.handlers.loan_label_create","summary":"Create loan label","securityGroups":[{"oauth2":["loan.label:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5888","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5888"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}},"schemaId":"schema_5889"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5889","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_label_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels"},{"label":"Get loans by loan labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","metadata":{"seo":{"title":"Get loans by loan labels","description":"Get loans by loan labels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_labels_get_loans","name":"Get loans by loan labels","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loans by loan labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanLabelIds","in":"path","schemaId":"schema_5890","description":"The IDs of the loan labels","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanLabelIds","in":"path","required":true,"schemaId":"schema_5890"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","href":"loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","openApiOperationId":"peach.loans.labels.handlers.loan_labels_get_loans","summary":"Get loans by loan labels","securityGroups":[{"oauth2":["loan.label:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5891"}},"schemaId":"schema_5891"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5891"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans"},{"label":"Add labels to loans","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","metadata":{"seo":{"title":"Add labels to loans","description":"Adds loans to the specified labels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_labels_add_loans","name":"Add labels to loans","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add labels to loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds loans to the specified labels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanLabelIds","in":"path","schemaId":"schema_5890","description":"The IDs of the loan labels","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"schemaId":"components/schemas/LoanIdsRequest","pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanLabelIds","in":"path","required":true,"schemaId":"schema_5890"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","href":"loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","openApiOperationId":"peach.loans.labels.handlers.loan_labels_add_loans","summary":"Add labels to loans","securityGroups":[{"oauth2":["loan.label:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanIdsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans"},{"label":"Remove labels from loans","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","metadata":{"seo":{"title":"Remove labels from loans","description":"Remove loans from the specified labels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_labels_remove_loans","name":"Remove labels from loans","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans~1remove/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove labels from loans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove loans from the specified labels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanLabelIds","in":"path","schemaId":"schema_5890","description":"The IDs of the loan labels","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans~1remove/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"schemaId":"components/schemas/LoanIdsRequest","pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans~1remove/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanLabelIds","in":"path","required":true,"schemaId":"schema_5890"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove","href":"loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","openApiOperationId":"peach.loans.labels.handlers.loan_labels_remove_loans","summary":"Remove labels from loans","securityGroups":[{"oauth2":["loan.label:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanIdsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanIdsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelIds}~1loans~1remove/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove"},{"label":"Delete loan label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_delete","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_delete","metadata":{"seo":{"title":"Delete loan label","description":"Delete loan label"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_label_delete","name":"Delete loan label","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete loan label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanLabelId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan label","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/loan-labels/{loanLabelId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanLabelId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelId}","href":"loan-labels/peach.loans.labels.handlers.loan_label_delete","openApiOperationId":"peach.loans.labels.handlers.loan_label_delete","summary":"Delete loan label","securityGroups":[{"oauth2":["loan.label:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_label_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}"},{"label":"Get loan label by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_get","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_get","metadata":{"seo":{"title":"Get loan label by ID","description":"Get loan label by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_label_get","name":"Get loan label by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan label by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanLabelId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan label","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-labels/{loanLabelId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanLabelId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelId}","href":"loan-labels/peach.loans.labels.handlers.loan_label_get","openApiOperationId":"peach.loans.labels.handlers.loan_label_get","summary":"Get loan label by ID","securityGroups":[{"oauth2":["loan.label:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}},"schemaId":"schema_5889"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5889","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_label_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}"},{"label":"Update loan label","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_update","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_update","metadata":{"seo":{"title":"Update loan label","description":"Updates a loan label."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.labels.handlers.loan_label_update","name":"Update loan label","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a loan label."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.label:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanLabelId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan label","required":true},{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanLabel"}},"schemaId":"components/schemas/LoanLabel","pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loan-labels/{loanLabelId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanLabelId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.label:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanLabel"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-labels/{loanLabelId}","href":"loan-labels/peach.loans.labels.handlers.loan_label_update","openApiOperationId":"peach.loans.labels.handlers.loan_label_update","summary":"Update loan label","securityGroups":[{"oauth2":["loan.label:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanLabel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanLabel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}},"schemaId":"schema_5889"}],"pointer":"/paths/~1companies~1{companyId}~1loan-labels~1{loanLabelId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5889","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5889"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-labels/peach.loans.labels.handlers.loan_label_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}"}],"content":{"contentType":"group","meta":{"name":"Loan Labels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Labels","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/loan-labels","summary":"Get loan labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_labels_list","deprecated":false},{"title":"/companies/{companyId}/loan-labels","summary":"Create loan label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_label_create","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","summary":"Get loans by loan labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","summary":"Add labels to loans","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove","summary":"Remove labels from loans","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelId}","summary":"Delete loan label","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_label_delete","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelId}","summary":"Get loan label by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_label_get","deprecated":false},{"title":"/companies/{companyId}/loan-labels/{loanLabelId}","summary":"Update loan label","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loan-labels/peach.loans.labels.handlers.loan_label_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Communicator & Interactions","content":null},{"type":"group","label":"Communicator","link":"/api-docs/api-public/communicator","routeSlug":"/api-docs/api-public/communicator","items":[{"label":"Render template preview for subject","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.preview","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.preview","metadata":{"seo":{"title":"Render template preview for subject","description":"Render the template and return as a JSON response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.preview","name":"Render template preview for subject","isWebhook":false,"pointer":"/paths/~1communicator~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render template preview for subject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render the template and return as a JSON response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It selects an appropriate Template Descriptor (matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renders the active Template Version with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three contents are returned in a single JSON response, they are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentHtml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/render"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints because it does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but rather the simple text-respresentation of the rendered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"templates that would be used in rendering a file. It is generally easier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to test and debug the rendered templates as JSON strings rather than, for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance a PDF file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5892"}},"schemaId":"schema_5892","pointer":"/paths/~1communicator~1preview/post/requestBody","description":"Template selectors and the data."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/preview","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5892"}},"responseCodes":["200"],"pointer":"/communicator/preview","href":"communicator/peach.communicator.handlers.preview","openApiOperationId":"peach.communicator.handlers.preview","summary":"Render template preview for subject","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5892","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5892"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}},"schemaId":"schema_5893"}],"pointer":"/paths/~1communicator~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5893","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.preview"}],"panels":[]}]},"httpPath":"/communicator/preview"},{"label":"Preview free-form email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.preview_free_form_email","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.preview_free_form_email","metadata":{"seo":{"title":"Preview free-form email","description":"Render a template for \"free-form\" emails and return is as JSON."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.preview_free_form_email","name":"Preview free-form email","isWebhook":false,"pointer":"/paths/~1communicator~1preview-free-form-email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview free-form email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a template for \"free-form\" emails and return is as JSON."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A free-form message is one that can contain any content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates previewed via this endpoint will be free-form but still be branded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i.e., they will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeFormBranded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interaction subject, not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeForm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This returns the three contents of a template in a single JSON response,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentHtml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5894"}},"schemaId":"schema_5894","pointer":"/paths/~1communicator~1preview-free-form-email/post/requestBody","description":"Subject line and content of the free form email."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/preview-free-form-email","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5894"}},"responseCodes":["200"],"pointer":"/communicator/preview-free-form-email","href":"communicator/peach.communicator.handlers.preview_free_form_email","openApiOperationId":"peach.communicator.handlers.preview_free_form_email","summary":"Preview free-form email","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5894","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5894"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}},"schemaId":"schema_5893"}],"pointer":"/paths/~1communicator~1preview-free-form-email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5893","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.preview_free_form_email"}],"panels":[]}]},"httpPath":"/communicator/preview-free-form-email"},{"label":"Receive message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_receive","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_receive","metadata":{"seo":{"title":"Receive message","description":"Receive a message."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.handle_receive","name":"Receive message","isWebhook":false,"pointer":"/paths/~1communicator~1receive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive a message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is different from a normal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/interactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it creates the interaction and also performs associated \"inbound message\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the message is an email sent to an email address configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"unmonitored\", it will autorespond that the email was not received because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it was sent to an \"unmonitored address\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it will publish a taskrouter task for inbound interactions (either"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handleInboundInteraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handleUnboundInboundInteraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5895"}},"schemaId":"schema_5895","pointer":"/paths/~1communicator~1receive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/receive","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5895"}},"responseCodes":["200"],"pointer":"/communicator/receive","href":"communicator/peach.communicator.handlers.handle_receive","openApiOperationId":"peach.communicator.handlers.handle_receive","summary":"Receive message","securityGroups":[{"oauth2":["interaction:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5895","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5895"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}},"schemaId":"schema_5896"}],"pointer":"/paths/~1communicator~1receive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.handle_receive"}],"panels":[]}]},"httpPath":"/communicator/receive"},{"label":"Render to download","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.render","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.render","metadata":{"seo":{"title":"Render to download","description":"Render a file (text, html or pdf) from template and download it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.render","name":"Render to download","isWebhook":false,"pointer":"/paths/~1communicator~1render/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render to download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from template and download it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It selects an appropriate Template Descriptor (matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renders the active Template Version with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the content matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fmt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is returned in the file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rendered template file is then downloaded as an attachment. (i.e., a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response is sent with the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition: attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: that a Document Descriptor is NOT created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fmt","in":"query","schemaId":"schema_5897","description":"The desired output format."}],"pointer":"/paths/~1communicator~1render/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5898"}},"schemaId":"schema_5898","pointer":"/paths/~1communicator~1render/post/requestBody","description":"Template selectors and the data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/render","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"fmt","in":"query","schemaId":"schema_5897"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5898"}},"responseCodes":["200"],"pointer":"/communicator/render","href":"communicator/peach.communicator.handlers.render","openApiOperationId":"peach.communicator.handlers.render","summary":"Render to download","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5898","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5898"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1render/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.render"}],"panels":[]}]},"httpPath":"/communicator/render"},{"label":"Render to document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.render_to_document","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.render_to_document","metadata":{"seo":{"title":"Render to document","description":"Render a file (text, html or pdf) from template and write it to a document descriptor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.render_to_document","name":"Render to document","isWebhook":false,"pointer":"/paths/~1communicator~1render-to-document/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render to document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from template and write it to a document descriptor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It selects an appropriate Template Descriptor (matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renders the active Template Version with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the content matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fmt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is returned in the file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rendered template file is then associated with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". (i.e., this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new content can be downloaded via that Document Descriptor.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING: if there is existing document content for that document it will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overwritten."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fmt","in":"query","schemaId":"schema_5897","description":"The desired output format."}],"pointer":"/paths/~1communicator~1render-to-document/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5899"}},"schemaId":"schema_5899","pointer":"/paths/~1communicator~1render-to-document/post/requestBody","description":"Template selectors, context and the document ID."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/render-to-document","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"fmt","in":"query","schemaId":"schema_5897"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5899"}},"responseCodes":["200"],"pointer":"/communicator/render-to-document","href":"communicator/peach.communicator.handlers.render_to_document","openApiOperationId":"peach.communicator.handlers.render_to_document","summary":"Render to document","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5899","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5899"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1render-to-document/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.render_to_document"}],"panels":[]}]},"httpPath":"/communicator/render-to-document"},{"label":"Resend existing interaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.resend","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.resend","metadata":{"seo":{"title":"Resend existing interaction","description":"Copy the fields from an existing interaction into a new interaction and queue that new interaction for sending."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.resend","name":"Resend existing interaction","isWebhook":false,"pointer":"/paths/~1communicator~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend existing interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copy the fields from an existing interaction into a new interaction\nand queue that new interaction for sending. \n\nWARNING: This message is not checked against Compliance Guard.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5900"}},"schemaId":"schema_5900","pointer":"/paths/~1communicator~1resend/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/resend","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5900"}},"responseCodes":["202","404"],"pointer":"/communicator/resend","href":"communicator/peach.communicator.handlers.resend","openApiOperationId":"peach.communicator.handlers.resend","summary":"Resend existing interaction","securityGroups":[{"oauth2":["communicator:send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5900","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5900"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5901"}},"schemaId":"schema_5901"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1communicator~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5901","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5901"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.resend"}],"panels":[]}]},"httpPath":"/communicator/resend"},{"label":"Send message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send","metadata":{"seo":{"title":"Send message","description":"Send a message and save it as a new interaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.handle_send","name":"Send message","isWebhook":false,"pointer":"/paths/~1communicator~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a message and save it as a new interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message is checked against Compliance Guard and may be rejected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if it violates any rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the message is accepted, it is queued for send."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the status of the queued interaction by calling"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/interactions/{interactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with the interaction ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned by this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"communicator/peach.communicator.handlers.handle_send/request/context-variables","deepLinkHash":"/communicator/peach.communicator.handlers.handle_send#communicator/peach.communicator.handlers.handle_send/request/context-variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"communicator/peach.communicator.handlers.handle_send/request/hydratable-context-variables","deepLinkHash":"/communicator/peach.communicator.handlers.handle_send#communicator/peach.communicator.handlers.handle_send/request/hydratable-context-variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hydratable Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certain context variables can be \"hydrated\" by this endpoint for use in the template"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being rendered for sending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For instance, if you provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body it is \"hydrated\" to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object and passed to the context. This means you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can then reference things like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{loan.displayId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when customizing the template."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hydrates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hydrates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hydrates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hydrates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"communicator/peach.communicator.handlers.handle_send/request/no-automatic-context-variables","deepLinkHash":"/communicator/peach.communicator.handlers.handle_send#communicator/peach.communicator.handlers.handle_send/request/no-automatic-context-variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Automatic Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this endpoint does not automatically fill in context variables."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the template you're sending requires context variables, you must provide them. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can sometimes be confusing because Peach will automatically calculate and include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context variables when the system sends a message automatically. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/system-sent-messages"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System Sent Messages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"communicator/peach.communicator.handlers.handle_send/request/difference-from-interactions-endpoint","deepLinkHash":"/communicator/peach.communicator.handlers.handle_send#communicator/peach.communicator.handlers.handle_send/request/difference-from-interactions-endpoint"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Difference from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/interactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note this is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ing to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/interactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint because those"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints create the interaction object, but do NOT send an actual message."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(You can think of that endpoint as creating a historical log of an interaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which happened elsewhere.)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicatorSend"}},"schemaId":"components/schemas/CommunicatorSend","pointer":"/paths/~1communicator~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/send","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommunicatorSend"}},"responseCodes":["202","409"],"pointer":"/communicator/send","href":"communicator/peach.communicator.handlers.handle_send","openApiOperationId":"peach.communicator.handlers.handle_send","summary":"Send message","securityGroups":[{"oauth2":["communicator:send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CommunicatorSend","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicatorSend"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"OK"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was well-formed but was unable to be processed due to failed business logic validations. This includes scenarios where:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The template for this type of message is disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No suitable email or phone contact found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact does not belong to the specified borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The borrower is inactive or not eligible for the type of interaction attempted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Communication consent for the requested channel has been revoked by the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact information is marked as invalid or archived."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The borrower has opted out of receiving certain types of messages (e.g., text messages) to the specified contact method."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interaction is blocked by Compliance Guard due to federal, state, or business rules violations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request fails due to time-of-day restrictions outside permitted communication hours, though this case will specifically include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute indicating the next allowable time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan associated with the communication is missing critical details or does not belong to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invalid address prevents determining applicable state rules for communication."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each failure is accompanied by a detailed message explaining the specific reason the interaction cannot proceed."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5902"}},"schemaId":"schema_5902"}],"pointer":"/paths/~1communicator~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"409","schemaId":"schema_5902","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5902"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.handle_send"}],"panels":[]}]},"httpPath":"/communicator/send"},{"label":"Send confirmation code for contact verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","routeSlug":"/api-docs/api-public/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","metadata":{"seo":{"title":"Send confirmation code for contact verification","description":"Send a verification code to an email or phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.confirmation_codes.handlers.send_confirmation_code","name":"Send confirmation code for contact verification","isWebhook":false,"pointer":"/paths/~1communicator~1send-confirmation-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send confirmation code for contact verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a verification code to an email or phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates a confirmation code in the system which can be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".../contacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to verify the contact. (i.e., this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute of the contact to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is rate limited to 10 requests per "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per hour."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An interaction is created with InteractionSubject "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This endpoint is not checked against Compliance Guard, however"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it should never be necessary to restrict sending confirmation codes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due to compliance guard rules."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.confirmationcode:send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5903"}},"schemaId":"schema_5903","pointer":"/paths/~1communicator~1send-confirmation-code/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/send-confirmation-code","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.confirmationcode:send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5903"}},"responseCodes":["202"],"pointer":"/communicator/send-confirmation-code","href":"communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","openApiOperationId":"peach.communicator.confirmation_codes.handlers.send_confirmation_code","summary":"Send confirmation code for contact verification","securityGroups":[{"oauth2":["communicator.confirmationcode:send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5903","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5903"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"OK"}],"pointer":"/paths/~1communicator~1send-confirmation-code/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code"}],"panels":[]}]},"httpPath":"/communicator/send-confirmation-code"},{"label":"Send free-form email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.send_free_form_email","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.send_free_form_email","metadata":{"seo":{"title":"Send free-form email","description":"Sends an email with the freeFormBranded template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.send_free_form_email","name":"Send free-form email","isWebhook":false,"pointer":"/paths/~1communicator~1send-free-form-email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send free-form email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an email with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeFormBranded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This selects the Template Descriptor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject=freeFormBranded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its currently active Template Version. The `freeFormBranded`` template allows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the insertion of completely custom content within a standard branded email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING: This endpoint is not checked against Compliance Guard."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:send"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5904"}},"schemaId":"schema_5904","pointer":"/paths/~1communicator~1send-free-form-email/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/send-free-form-email","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:send"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5904"}},"responseCodes":["202"],"pointer":"/communicator/send-free-form-email","href":"communicator/peach.communicator.handlers.send_free_form_email","openApiOperationId":"peach.communicator.handlers.send_free_form_email","summary":"Send free-form email","securityGroups":[{"oauth2":["communicator:send"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5904","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5904"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5905"}},"schemaId":"schema_5905"}],"pointer":"/paths/~1communicator~1send-free-form-email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_5905","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5905"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.send_free_form_email"}],"panels":[]}]},"httpPath":"/communicator/send-free-form-email"},{"label":"List subject desciptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptors_list","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptors_list","metadata":{"seo":{"title":"List subject desciptors","description":"List all the currently available Interaction Subject descriptors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.subject_descriptors_list","name":"List subject desciptors","isWebhook":false,"pointer":"/paths/~1communicator~1subjects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subject desciptors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all the currently available Interaction Subject descriptors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An interaction subject is the category or topic to which an interaction pertains."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Note this is different from the subject line of an email message.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, an email or a text message will necessarily contain different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content due to their nature, but they still might pertain to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Similarly, a phone call despite not being"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text based at all might also pertain to the subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/subjects","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/subjects","href":"communicator/peach.communicator.handlers.subject_descriptors_list","openApiOperationId":"peach.communicator.handlers.subject_descriptors_list","summary":"List subject desciptors","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5906"}},"schemaId":"schema_5906"}],"pointer":"/paths/~1communicator~1subjects/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5906","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5906"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.subject_descriptors_list"}],"panels":[]}]},"httpPath":"/communicator/subjects"},{"label":"Get subject descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","metadata":{"seo":{"title":"Get subject descriptor","description":"Get the descriptor for a specific Interaction Subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.subject_descriptor_get_by_subject","name":"Get subject descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1subjects~1{subject}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subject descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the descriptor for a specific Interaction Subject."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that subject descriptors do not have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field but are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead identified by their unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subject","in":"path","schemaId":"schema_5907","required":true}],"pointer":"/paths/~1communicator~1subjects~1{subject}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/subjects/{subject}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"subject","in":"path","required":true,"schemaId":"components/schemas/InteractionSubject"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/subjects/{subject}","href":"communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","openApiOperationId":"peach.communicator.handlers.subject_descriptor_get_by_subject","summary":"Get subject descriptor","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}},"schemaId":"components/schemas/SubjectDescriptor"}],"pointer":"/paths/~1communicator~1subjects~1{subject}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubjectDescriptor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject"}],"panels":[]}]},"httpPath":"/communicator/subjects/{subject}"},{"label":"Update subject descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_update","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_update","metadata":{"seo":{"title":"Update subject descriptor","description":"Update the descriptor for a specific Interaction Subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.subject_descriptor_update","name":"Update subject descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1subjects~1{subject}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subject descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the descriptor for a specific Interaction Subject."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that subject descriptors do not have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field but are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead identified by their unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subject","in":"path","schemaId":"schema_5907","required":true}],"pointer":"/paths/~1communicator~1subjects~1{subject}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}},"schemaId":"components/schemas/SubjectDescriptor","pointer":"/paths/~1communicator~1subjects~1{subject}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/communicator/subjects/{subject}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"subject","in":"path","required":true,"schemaId":"components/schemas/InteractionSubject"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}},"responseCodes":["200"],"pointer":"/communicator/subjects/{subject}","href":"communicator/peach.communicator.handlers.subject_descriptor_update","openApiOperationId":"peach.communicator.handlers.subject_descriptor_update","summary":"Update subject descriptor","securityGroups":[{"oauth2":["communicator.template:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/SubjectDescriptor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}},"schemaId":"components/schemas/SubjectDescriptor"}],"pointer":"/paths/~1communicator~1subjects~1{subject}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubjectDescriptor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectDescriptor"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communicator/peach.communicator.handlers.subject_descriptor_update"}],"panels":[]}]},"httpPath":"/communicator/subjects/{subject}"}],"content":{"contentType":"group","meta":{"name":"Communicator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Communicator","showPageActions":true},{"nodeType":"markdoc","content":"Send and receive communications like email and text messages with borrowers and their contacts. When\nsending and receiving communications an interaction is usually created."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/communicator/preview","summary":"Render template preview for subject","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.preview","deprecated":false},{"title":"/communicator/preview-free-form-email","summary":"Preview free-form email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.preview_free_form_email","deprecated":false},{"title":"/communicator/receive","summary":"Receive message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.handle_receive","deprecated":false},{"title":"/communicator/render","summary":"Render to download","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.render","deprecated":false},{"title":"/communicator/render-to-document","summary":"Render to document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.render_to_document","deprecated":false},{"title":"/communicator/resend","summary":"Resend existing interaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.resend","deprecated":false},{"title":"/communicator/send","summary":"Send message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.handle_send","deprecated":false},{"title":"/communicator/send-confirmation-code","summary":"Send confirmation code for contact verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","deprecated":false},{"title":"/communicator/send-free-form-email","summary":"Send free-form email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communicator/peach.communicator.handlers.send_free_form_email","deprecated":false},{"title":"/communicator/subjects","summary":"List subject desciptors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/communicator/peach.communicator.handlers.subject_descriptors_list","deprecated":false},{"title":"/communicator/subjects/{subject}","summary":"Get subject descriptor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","deprecated":false},{"title":"/communicator/subjects/{subject}","summary":"Update subject descriptor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/communicator/peach.communicator.handlers.subject_descriptor_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Templates","link":"/api-docs/api-public/templates","routeSlug":"/api-docs/api-public/templates","items":[{"type":"link","label":"Management","link":"/api-docs/api-public/templates/management","routeSlug":"/api-docs/api-public/templates/management","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Management"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"templates/management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Management"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The templates system consists of two main components: Template Descriptors and Template Versions (also sometimes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"simply referred to as \"templates\"). A Template Descriptor is a configuration object that defines the structure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a template. A Template Version is a specific instance of a template that contains the actual content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Template Descriptor many have many Template Versions associated with it. There can be only one \"active\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template Version at a time."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Content","link":"/api-docs/api-public/templates/content","routeSlug":"/api-docs/api-public/templates/content","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Content"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"templates/content"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Syntax","link":"/api-docs/api-public/templates/syntax","routeSlug":"/api-docs/api-public/templates/syntax","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Syntax"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"templates/syntax"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syntax"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach uses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://jinja.palletsprojects.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jinja templating"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Therefore all templates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use Jinja template syntax, and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be a valid Jinja template to render"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Rendering Context","link":"/api-docs/api-public/templates/rendering-context","routeSlug":"/api-docs/api-public/templates/rendering-context","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Rendering Context"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"templates/rendering-context"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rendering Context"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a template is rendered, context variables are passed into the template. If a template looks like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Hello {{foo}}, your loan is due on {{bar}}.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Hello {{foo}}, your loan is due on {{bar}}.\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the context variables in the template are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If, when the template is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rendered, the provided context is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"foo\": \"John\",\n  \"bar\": \"2021-01-01\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"foo\": \"John\",\n  \"bar\": \"2021-01-01\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"...then the rendered template will be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Hello John, your loan is due on 2021-01-01.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Hello John, your loan is due on 2021-01-01.\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List template descriptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_descriptors","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_descriptors","metadata":{"seo":{"title":"List template descriptors","description":"List template descriptors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.list_template_descriptors","name":"List template descriptors","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List template descriptors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"companyId","in":"query","schemaId":"schema_5908","description":"The Company ID by which to filter.","example":"CP-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templatedescriptors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templatedescriptors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"companyId","in":"query","example":"CP-AAAA-BBBB","schemaId":"components/schemas/CompanyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/communicator/templatedescriptors","href":"templates/peach.communicator.handlers.list_template_descriptors","openApiOperationId":"peach.communicator.handlers.list_template_descriptors","summary":"List template descriptors","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5909"}},"schemaId":"schema_5909"},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1communicator~1templatedescriptors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5909","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5909"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.list_template_descriptors"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors"},{"label":"Create template descriptor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_descriptor","metadata":{"seo":{"title":"Create template descriptor","description":"Create template descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.create_template_descriptor","name":"Create template descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create template descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"schemaId":"components/schemas/TemplateDescriptorMutate","pointer":"/paths/~1communicator~1templatedescriptors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/templatedescriptors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"responseCodes":["200","400"],"pointer":"/communicator/templatedescriptors","href":"templates/peach.communicator.handlers.create_template_descriptor","openApiOperationId":"peach.communicator.handlers.create_template_descriptor","summary":"Create template descriptor","securityGroups":[{"oauth2":["communicator.template:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TemplateDescriptorMutate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}},"schemaId":"components/schemas/TemplateDescriptor"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templatedescriptors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDescriptor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.create_template_descriptor"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors"},{"label":"Delete template descriptor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_descriptor","metadata":{"seo":{"title":"Delete template descriptor","description":"Delete template descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.delete_template_descriptor","name":"Delete template descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"descriptorId","in":"path","schemaId":"schema_5910","description":"ID of the Template Descriptor.","required":true,"example":"TD-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/communicator/templatedescriptors/{descriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"descriptorId","in":"path","required":true,"example":"TD-AAAA-BBBB","schemaId":"components/schemas/TemplateDescriptorId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/communicator/templatedescriptors/{descriptorId}","href":"templates/peach.communicator.handlers.delete_template_descriptor","openApiOperationId":"peach.communicator.handlers.delete_template_descriptor","summary":"Delete template descriptor","securityGroups":[{"oauth2":["communicator.template:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.delete_template_descriptor"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors/{descriptorId}"},{"label":"Get template descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_descriptor","metadata":{"seo":{"title":"Get template descriptor","description":"Get template descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.get_template_descriptor","name":"Get template descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"descriptorId","in":"path","schemaId":"schema_5910","description":"ID of the Template Descriptor.","required":true,"example":"TD-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templatedescriptors/{descriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"descriptorId","in":"path","required":true,"example":"TD-AAAA-BBBB","schemaId":"components/schemas/TemplateDescriptorId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/communicator/templatedescriptors/{descriptorId}","href":"templates/peach.communicator.handlers.get_template_descriptor","openApiOperationId":"peach.communicator.handlers.get_template_descriptor","summary":"Get template descriptor","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}},"schemaId":"components/schemas/TemplateDescriptor"},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDescriptor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.get_template_descriptor"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors/{descriptorId}"},{"label":"Update template descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_descriptor","metadata":{"seo":{"title":"Update template descriptor","description":"Update template descriptor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.update_template_descriptor","name":"Update template descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"descriptorId","in":"path","schemaId":"schema_5910","description":"ID of the Template Descriptor.","required":true,"example":"TD-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"schemaId":"components/schemas/TemplateDescriptorMutate","pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/put/requestBody","description":"The updated template descriptor"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/communicator/templatedescriptors/{descriptorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"descriptorId","in":"path","required":true,"example":"TD-AAAA-BBBB","schemaId":"components/schemas/TemplateDescriptorId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"responseCodes":["200","400"],"pointer":"/communicator/templatedescriptors/{descriptorId}","href":"templates/peach.communicator.handlers.update_template_descriptor","openApiOperationId":"peach.communicator.handlers.update_template_descriptor","summary":"Update template descriptor","securityGroups":[{"oauth2":["communicator.template:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TemplateDescriptorMutate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateDescriptorMutate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}},"schemaId":"components/schemas/TemplateDescriptor"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDescriptor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDescriptor"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.update_template_descriptor"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors/{descriptorId}"},{"label":"List template versions for descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_by_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_by_descriptor","metadata":{"seo":{"title":"List template versions for descriptor","description":"List all template versions for the given template descriptor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.list_template_versions_by_descriptor","name":"List template versions for descriptor","isWebhook":false,"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List template versions for descriptor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all template versions for the given template descriptor."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"descriptorId","in":"path","schemaId":"schema_5910","description":"ID of the Template Descriptor.","required":true,"example":"TD-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templatedescriptors/{descriptorId}/templates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"descriptorId","in":"path","required":true,"example":"TD-AAAA-BBBB","schemaId":"components/schemas/TemplateDescriptorId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templatedescriptors/{descriptorId}/templates","href":"templates/peach.communicator.handlers.list_template_versions_by_descriptor","openApiOperationId":"peach.communicator.handlers.list_template_versions_by_descriptor","summary":"List template versions for descriptor","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5911"}},"schemaId":"schema_5911"}],"pointer":"/paths/~1communicator~1templatedescriptors~1{descriptorId}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5911","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5911"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.list_template_versions_by_descriptor"}],"panels":[]}]},"httpPath":"/communicator/templatedescriptors/{descriptorId}/templates"},{"label":"List all template versions (Deprecated)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions","metadata":{"seo":{"title":"List all template versions (Deprecated)","description":"List all template versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.list_template_versions","name":"List all template versions (Deprecated)","isWebhook":false,"pointer":"/paths/~1communicator~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all template versions (Deprecated)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all template versions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/communicator/templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This dumps all template versions (regardless of active status) without paging."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"schema_5908","description":"The Company ID by which to filter.","example":"CP-AAAA-BBBB"}],"pointer":"/paths/~1communicator~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","example":"CP-AAAA-BBBB","schemaId":"components/schemas/CompanyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templates","href":"templates/peach.communicator.handlers.list_template_versions","openApiOperationId":"peach.communicator.handlers.list_template_versions","summary":"List all template versions (Deprecated)","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5911"}},"schemaId":"schema_5911"}],"pointer":"/paths/~1communicator~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5911","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5911"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.list_template_versions"}],"panels":[]}]},"httpPath":"/communicator/templates"},{"label":"Create template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_version","metadata":{"seo":{"title":"Create template version","description":"Create a new template versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.create_template_version","name":"Create template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new template versions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default the new version will not be active until it is activated with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/templates/peach.communicator.handlers.activate_template_version"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the activate endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body to create and activate the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version in a single call. Doing so requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicator.template:activate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission in addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicator.template:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"schemaId":"components/schemas/TemplateVersionMutate","pointer":"/paths/~1communicator~1templates/post/requestBody","description":"The new template"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/templates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"responseCodes":["200","400"],"pointer":"/communicator/templates","href":"templates/peach.communicator.handlers.create_template_version","openApiOperationId":"peach.communicator.handlers.create_template_version","summary":"Create template version","securityGroups":[{"oauth2":["communicator.template:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TemplateVersionMutate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}},"schemaId":"components/schemas/TemplateVersion"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.create_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates"},{"label":"Export all template descriptors and versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.export_templates","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.export_templates","metadata":{"seo":{"title":"Export all template descriptors and versions","description":"Export all template descriptors and template versions for a company. The export is in JSON format. It can be used with the import endpoint to restore templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.export_templates","name":"Export all template descriptors and versions","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export all template descriptors and versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Export all template descriptors and template versions for a company. \nThe export is in JSON format. It can be used with the import endpoint to\nrestore templates.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"components/schemas/newStatus","description":"The company to export templates","required":true},{"name":"activeOnly","in":"query","schemaId":"schema_5644","description":"Export only active templates"}],"pointer":"/paths/~1communicator~1templates~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templates/export","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","required":true,"schemaId":"components/schemas/newStatus"},{"name":"activeOnly","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templates/export","href":"templates/peach.communicator.handlers.export_templates","openApiOperationId":"peach.communicator.handlers.export_templates","summary":"Export all template descriptors and versions","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5912"}},"schemaId":"schema_5912"}],"pointer":"/paths/~1communicator~1templates~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5912","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5912"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.export_templates"}],"panels":[]}]},"httpPath":"/communicator/templates/export"},{"label":"Import exported template descriptors and versions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.import_templates","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.import_templates","metadata":{"seo":{"title":"Import exported template descriptors and versions","description":"Import exported template descriptors and template versions for a company. The exporteddata should come from the /communicator/templates/export endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.import_templates","name":"Import exported template descriptors and versions","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import exported template descriptors and versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import exported template descriptors and template versions for a company. The exported"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data should come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communicator/templates/export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The import will create new template descriptor if a matching one does not exist"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will create new template versions if a matching one does not exist. This is often"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used to \"promote\" templates from a testing environment to a production environment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"components/schemas/newStatus","description":"The company to import templates for","required":true},{"name":"allowActivate","in":"query","schemaId":"schema_5644","description":"If an imported version data has new content and is marked active,\nactivate the newly created template version.\n"}],"pointer":"/paths/~1communicator~1templates~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5912"}},"schemaId":"schema_5912","pointer":"/paths/~1communicator~1templates~1import/post/requestBody","description":"The exported template data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/templates/import","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"companyId","in":"query","required":true,"schemaId":"components/schemas/newStatus"},{"name":"allowActivate","in":"query","schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5912"}},"responseCodes":["204"],"pointer":"/communicator/templates/import","href":"templates/peach.communicator.handlers.import_templates","openApiOperationId":"peach.communicator.handlers.import_templates","summary":"Import exported template descriptors and versions","securityGroups":[{"oauth2":["communicator.template:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5912","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5912"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully imported"}],"pointer":"/paths/~1communicator~1templates~1import/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.import_templates"}],"panels":[]}]},"httpPath":"/communicator/templates/import"},{"label":"Get template version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_version","metadata":{"seo":{"title":"Get template version","description":"Get template version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.get_template_version","name":"Get template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templates/{templateVersionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templates/{templateVersionId}","href":"templates/peach.communicator.handlers.get_template_version","openApiOperationId":"peach.communicator.handlers.get_template_version","summary":"Get template version","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}},"schemaId":"components/schemas/TemplateVersion"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.get_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}"},{"label":"Update template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_version","metadata":{"seo":{"title":"Update template version","description":"Update template version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.update_template_version","name":"Update template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"schemaId":"components/schemas/TemplateVersionMutate","pointer":"/paths/~1communicator~1templates~1{templateVersionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/communicator/templates/{templateVersionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"responseCodes":["200","400"],"pointer":"/communicator/templates/{templateVersionId}","href":"templates/peach.communicator.handlers.update_template_version","openApiOperationId":"peach.communicator.handlers.update_template_version","summary":"Update template version","securityGroups":[{"oauth2":["communicator.template:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/TemplateVersionMutate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateVersionMutate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}},"schemaId":"components/schemas/TemplateVersion"},{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateVersion"}}},{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.update_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}"},{"label":"Activate template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.activate_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.activate_template_version","metadata":{"seo":{"title":"Activate template version","description":"Set's the given template version as active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.activate_template_version","name":"Activate template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set's the given template version as active.\n\nA template descriptor can have exactly one \"active\" version. The active template\nversion is what's used to generate the content of the messages.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:activate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/communicator/templates/{templateVersionId}/activate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:activate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templates/{templateVersionId}/activate","href":"templates/peach.communicator.handlers.activate_template_version","openApiOperationId":"peach.communicator.handlers.activate_template_version","summary":"Activate template version","securityGroups":[{"oauth2":["communicator.template:activate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1activate/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.activate_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}/activate"},{"label":"Render template version preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.preview_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.preview_template_version","metadata":{"seo":{"title":"Render template version preview","description":"Render the template contents of the given Template Versionusing the given context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.preview_template_version","name":"Render template version preview","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render template version preview","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render the template contents of the given Template Version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using the given context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three contents are returned in a single JSON response, they are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentHtml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5914"}},"schemaId":"schema_5914","pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1preview/post/requestBody","description":"Context data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/templates/{templateVersionId}/preview","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5914"}},"responseCodes":["200"],"pointer":"/communicator/templates/{templateVersionId}/preview","href":"templates/peach.communicator.handlers.preview_template_version","openApiOperationId":"peach.communicator.handlers.preview_template_version","summary":"Render template version preview","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5914","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5914"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}},"schemaId":"schema_5893"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5893","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5893"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.preview_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}/preview"},{"label":"Render template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.render_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.render_template_version","metadata":{"seo":{"title":"Render template version","description":"Render a file (text, html or pdf) from this Template Version and download it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.render_template_version","name":"Render template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1render/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from this Template Version and download it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the content matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fmt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is returned in the file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rendered template file is then downloaded as an attachment. (i.e., a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response is sent with the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition: attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: that a Document Descriptor is NOT created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator:render"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1render/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fmt","in":"query","schemaId":"schema_5897","description":"The desired output format."}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1render/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5915"}},"schemaId":"schema_5915","pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1render/post/requestBody","description":"Template selectors and the data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicator/templates/{templateVersionId}/render","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[{"name":"fmt","in":"query","schemaId":"schema_5897"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator:render"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5915"}},"responseCodes":["200"],"pointer":"/communicator/templates/{templateVersionId}/render","href":"templates/peach.communicator.handlers.render_template_version","openApiOperationId":"peach.communicator.handlers.render_template_version","summary":"Render template version","securityGroups":[{"oauth2":["communicator:render"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5915","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5915"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/pdf","mediaTypes":["application/pdf","text/html","text/plain"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_5661"},"text/html":{"schemaId":"components/schemas/newStatus"},"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"schema_5661"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1render/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5661","mediaTypes":["application/pdf","text/html","text/plain"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_5661"},"text/html":{"schemaId":"components/schemas/newStatus"},"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.render_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}/render"},{"label":"List context vars for template version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_vars","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_vars","metadata":{"seo":{"title":"List context vars for template version","description":"List all context variables used in the given template version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.get_template_vars","name":"List context vars for template version","isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1vars/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List context vars for template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all context variables used in the given template version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a template looks like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Hello {{name}},\n\nYour loan {{loanName}} is due on {{dueDate}}.\n\nThanks,\n{{companyName}}\n\n{{SOME_MACRO()}}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Hello {{name}},\n\nYour loan {{loanName}} is due on {{dueDate}}.\n\nThanks,\n{{companyName}}\n\n{{SOME_MACRO()}}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"well as whatever context variables are defined in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SOME_MACRO()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SOME_MACRO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" itself is NOT a context variable). Note that this means"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sometimes a Template Version may contain many context variables since all possible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context variables are included in this list."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1vars/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicator/templates/{templateVersionId}/vars","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/communicator/templates/{templateVersionId}/vars","href":"templates/peach.communicator.handlers.get_template_vars","openApiOperationId":"peach.communicator.handlers.get_template_vars","summary":"List context vars for template version","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5632"}},"schemaId":"schema_5632"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}~1vars/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5632","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5632"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.get_template_vars"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}/vars"},{"label":"List all template versions (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_modern","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_modern","metadata":{"seo":{"title":"List all template versions (v2)","description":"List all Templates Versions for all Template Descriptors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.list_template_versions_modern","name":"List all template versions (v2)","isWebhook":false,"pointer":"/paths/~1v2~1communicator~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all template versions (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Templates Versions for all Template Descriptors.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"includeContextVars","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include all the context variables for this template."},"children":[]}]}]}]},{"name":"includeContents","in":"query","schemaId":"schema_5644","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the template contents, otherwise only return metadata."},"children":[]}]}]}]},{"name":"subject","in":"query","schemaId":"schema_5916","description":"Only include templates matching these interaction subjects."},{"name":"channel","in":"query","schemaId":"schema_5687","description":"Only include templates matching this set of interaction channels."}],"pointer":"/paths/~1v2~1communicator~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/communicator/templates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"includeContextVars","in":"query","required":false,"schemaId":"schema_5623"},{"name":"includeContents","in":"query","required":false,"schemaId":"schema_5644"},{"name":"subject","in":"query","required":false,"schemaId":"schema_5916"},{"name":"channel","in":"query","required":false,"schemaId":"schema_5687"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/communicator/templates","href":"templates/peach.communicator.handlers.list_template_versions_modern","openApiOperationId":"peach.communicator.handlers.list_template_versions_modern","summary":"List all template versions (v2)","securityGroups":[{"oauth2":["communicator.template:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5917"}},"schemaId":"schema_5917"}],"pointer":"/paths/~1v2~1communicator~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5917","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5917"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.list_template_versions_modern"}],"panels":[]}]},"httpPath":"/v2/communicator/templates"},{"label":"Delete template version (no longer supported)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_version","metadata":{"seo":{"title":"Delete template version (no longer supported)","description":"Deleting template versions is not allowed. Template versions are historical records. This endpoint is retained for backwards compatibility but responds with a 400 error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.communicator.handlers.delete_template_version","name":"Delete template version (no longer supported)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template version (no longer supported)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deleting template versions is not allowed. Template versions are historical records. This endpoint is retained for backwards compatibility but responds with a 400 error."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["communicator.template:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateVersionId","in":"path","schemaId":"schema_5913","description":"The Template Version ID.","required":true}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/communicator/templates/{templateVersionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"templateVersionId","in":"path","required":true,"example":"TV-AAAA-BBBB","schemaId":"components/schemas/TemplateVersionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["communicator.template:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["400"],"pointer":"/communicator/templates/{templateVersionId}","href":"templates/peach.communicator.handlers.delete_template_version","openApiOperationId":"peach.communicator.handlers.delete_template_version","summary":"Delete template version (no longer supported)","securityGroups":[{"oauth2":["communicator.template:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}},"schemaId":"components/schemas/newStatus"}],"pointer":"/paths/~1communicator~1templates~1{templateVersionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/newStatus","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/newStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/peach.communicator.handlers.delete_template_version"}],"panels":[]}]},"httpPath":"/communicator/templates/{templateVersionId}"}],"content":{"contentType":"group","meta":{"name":"Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The templates system is used manage templates and render content from existing templates. Templates can be used, for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance, when sending emails and text messages. Custom branding and dynamic fields can be added into"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"templates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/communicator/templatedescriptors","summary":"List template descriptors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.list_template_descriptors","deprecated":false},{"title":"/communicator/templatedescriptors","summary":"Create template descriptor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/peach.communicator.handlers.create_template_descriptor","deprecated":false},{"title":"/communicator/templatedescriptors/{descriptorId}","summary":"Delete template descriptor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/templates/peach.communicator.handlers.delete_template_descriptor","deprecated":false},{"title":"/communicator/templatedescriptors/{descriptorId}","summary":"Get template descriptor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.get_template_descriptor","deprecated":false},{"title":"/communicator/templatedescriptors/{descriptorId}","summary":"Update template descriptor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/templates/peach.communicator.handlers.update_template_descriptor","deprecated":false},{"title":"/communicator/templatedescriptors/{descriptorId}/templates","summary":"List template versions for descriptor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.list_template_versions_by_descriptor","deprecated":false},{"title":"/communicator/templates","summary":"List all template versions (Deprecated)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.list_template_versions","deprecated":false},{"title":"/communicator/templates","summary":"Create template version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/peach.communicator.handlers.create_template_version","deprecated":false},{"title":"/communicator/templates/export","summary":"Export all template descriptors and versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.export_templates","deprecated":false},{"title":"/communicator/templates/import","summary":"Import exported template descriptors and versions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/peach.communicator.handlers.import_templates","deprecated":false},{"title":"/communicator/templates/{templateVersionId}","summary":"Get template version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.get_template_version","deprecated":false},{"title":"/communicator/templates/{templateVersionId}","summary":"Update template version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/templates/peach.communicator.handlers.update_template_version","deprecated":false},{"title":"/communicator/templates/{templateVersionId}/activate","summary":"Activate template version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/templates/peach.communicator.handlers.activate_template_version","deprecated":false},{"title":"/communicator/templates/{templateVersionId}/preview","summary":"Render template version preview","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/peach.communicator.handlers.preview_template_version","deprecated":false},{"title":"/communicator/templates/{templateVersionId}/render","summary":"Render template version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/peach.communicator.handlers.render_template_version","deprecated":false},{"title":"/communicator/templates/{templateVersionId}/vars","summary":"List context vars for template version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.get_template_vars","deprecated":false},{"title":"/v2/communicator/templates","summary":"List all template versions (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/peach.communicator.handlers.list_template_versions_modern","deprecated":false},{"title":"/communicator/templates/{templateVersionId}","summary":"Delete template version (no longer supported)","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/templates/peach.communicator.handlers.delete_template_version","deprecated":true}]}]}]}]}},{"type":"group","label":"System Documents & UI","link":"/api-docs/api-public/system-documents-and-ui","routeSlug":"/api-docs/api-public/system-documents-and-ui","items":[{"type":"link","label":"Available Context Variables","link":"/api-docs/api-public/system-documents-and-ui/available-context-variables","routeSlug":"/api-docs/api-public/system-documents-and-ui/available-context-variables","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Available Context Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"system-documents-and-ui/available-context-variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this section of the docs you can see what context variables are automatically calculated for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given subject's system displayed message. (Note the list is currently incomplete.)"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"autopayAgreement","link":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectautopayagreement","routeSlug":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectautopayagreement","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayAgreement"},"seo":{"title":"autopayAgreement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayAgreement","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayAgreement"},"children":[]}]}]}},{"type":"link","label":"drawFundsDisclosure","link":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectdrawfundsdisclosure","routeSlug":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectdrawfundsdisclosure","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDrawFundsDisclosure"},"seo":{"title":"drawFundsDisclosure"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"drawFundsDisclosure","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDrawFundsDisclosure"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"System Documents & UI"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System Documents & UI","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach displays some messages as documents or UI elements. You may choose to customize the content of these messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using the templating system."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"autopayAgreement","link":"/system-documents-and-ui/availabletemplatecontextsubjectautopayagreement","deprecated":false},{"title":"drawFundsDisclosure","link":"/system-documents-and-ui/availabletemplatecontextsubjectdrawfundsdisclosure","deprecated":false}]}]}]}]}},{"type":"group","label":"System Sent Messages","link":"/api-docs/api-public/system-sent-messages","routeSlug":"/api-docs/api-public/system-sent-messages","items":[{"type":"link","label":"Automatically Calculated Context Vars","link":"/api-docs/api-public/system-sent-messages/automatically-calculated-context-vars","routeSlug":"/api-docs/api-public/system-sent-messages/automatically-calculated-context-vars","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Automatically Calculated Context Vars"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"system-sent-messages/automatically-calculated-context-vars"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically Calculated Context Vars"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Peach system sends messages it automatically calculates context variables."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These context variables can be referenced in the template content. For example, when the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it includes the populated context variables "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodLastFour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Customization","link":"/api-docs/api-public/system-sent-messages/customization","routeSlug":"/api-docs/api-public/system-sent-messages/customization","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Customization"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"system-sent-messages/customization"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customization"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach comes with predefined template content out-of-the-box. You can customize the content of these messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by updating the content of the template associated with the subject. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_version"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Template Version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to customize the content of a template it's important to understand that different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction subjects have different automatically calculated context variables."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, you can see below the subject "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayAmountChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with context variables"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extraCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This means"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the template with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject=autopayAmountChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you can write a template like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"comment","attributes":{"content":"We must include this jinja raw escape because Connexion runs the openapi spec through\n  a Jinja template render when loading the spec at boot up time.\n  We must put it in an HTML comment so Redoc doesn't show the raw escape in the docs. (I hate computers.)\n  {% raw %}"},"children":[]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Hello {{person.name.firstName}},\n\nThis is {{company.brandName}} from {{company.domainName}}, in regards to your loan\n{{loan.displayId}}.\n\nYour autopay changed. It is now {{paymentAmount}}. (That's an additional {{extraCharge}}.)\n\nBye!\n","language":"jinja"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Hello {{person.name.firstName}},\n\nThis is {{company.brandName}} from {{company.domainName}}, in regards to your loan\n{{loan.displayId}}.\n\nYour autopay changed. It is now {{paymentAmount}}. (That's an additional {{extraCharge}}.)\n\nBye!\n"},"children":[]}]},{"$$mdtype":"Node","type":"comment","attributes":{"content":"{% endraw %}"},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"Available Context Variables","link":"/api-docs/api-public/system-sent-messages/available-context-variables","routeSlug":"/api-docs/api-public/system-sent-messages/available-context-variables","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Available Context Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"system-sent-messages/available-context-variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this section of the docs you can see what context variables are automatically calculated for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given subject's system sent messages. (Note the list is currently incomplete.)"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"autopayAmountChanged","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayamountchanged","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayamountchanged","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayAmountChanged"},"seo":{"title":"autopayAmountChanged"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayAmountChanged","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayAmountChanged"},"children":[]}]}]}},{"type":"link","label":"autopayCanceledBySystem","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaycanceledbysystem","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaycanceledbysystem","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayCanceledBySystem"},"seo":{"title":"autopayCanceledBySystem"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayCanceledBySystem","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayCanceledBySystem"},"children":[]}]}]}},{"type":"link","label":"autopayEnabled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenabled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenabled","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayEnabled"},"seo":{"title":"autopayEnabled"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayEnabled","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayEnabled"},"children":[]}]}]}},{"type":"link","label":"autopayEnableReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenablereminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenablereminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayEnableReminder"},"seo":{"title":"autopayEnableReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayEnableReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayEnableReminder"},"children":[]}]}]}},{"type":"link","label":"autopayPaymentCanceled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentcanceled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentcanceled","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayPaymentCanceled"},"seo":{"title":"autopayPaymentCanceled"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayPaymentCanceled","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentCanceled"},"children":[]}]}]}},{"type":"link","label":"autopayPaymentMethodUpdated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentmethodupdated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentmethodupdated","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayPaymentMethodUpdated"},"seo":{"title":"autopayPaymentMethodUpdated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayPaymentMethodUpdated","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentMethodUpdated"},"children":[]}]}]}},{"type":"link","label":"autopayPaymentReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentreminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayPaymentReminder"},"seo":{"title":"autopayPaymentReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayPaymentReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentReminder"},"children":[]}]}]}},{"type":"link","label":"autopayPaymentRescheduled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentrescheduled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentrescheduled","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectAutopayPaymentRescheduled"},"seo":{"title":"autopayPaymentRescheduled"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"autopayPaymentRescheduled","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentRescheduled"},"children":[]}]}]}},{"type":"link","label":"cardExpiresReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcardexpiresreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcardexpiresreminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectCardExpiresReminder"},"seo":{"title":"cardExpiresReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"cardExpiresReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectCardExpiresReminder"},"children":[]}]}]}},{"type":"link","label":"ceaseCommunicationAcknowledgement","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceasecommunicationacknowledgement","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceasecommunicationacknowledgement","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectCeaseCommunicationAcknowledgement"},"seo":{"title":"ceaseCommunicationAcknowledgement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ceaseCommunicationAcknowledgement","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectCeaseCommunicationAcknowledgement"},"children":[]}]}]}},{"type":"link","label":"ceaseCommunicationRefuseToPay","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceaserefusetopay","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceaserefusetopay","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectCeaseRefuseToPay"},"seo":{"title":"ceaseCommunicationRefuseToPay"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ceaseCommunicationRefuseToPay","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectCeaseRefuseToPay"},"children":[]}]}]}},{"type":"link","label":"confirmationCode","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectconfirmationcode","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectconfirmationcode","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectConfirmationCode"},"seo":{"title":"confirmationCode"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"confirmationCode","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectConfirmationCode"},"children":[]}]}]}},{"type":"link","label":"contactTakeover","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcontacttakeover","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcontacttakeover","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectContactTakeover"},"seo":{"title":"contactTakeover"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"contactTakeover","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectContactTakeover"},"children":[]}]}]}},{"type":"link","label":"customX","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcustomx","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcustomx","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectCustomX"},"seo":{"title":"customX"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"customX","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectCustomX"},"children":[]}]}]}},{"type":"link","label":"debtValidationNotice","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnotice","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnotice","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDebtValidationNotice"},"seo":{"title":"debtValidationNotice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"debtValidationNotice","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNotice"},"children":[]}]}]}},{"type":"link","label":"debtValidationNoticeArizona","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticearizona","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticearizona","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDebtValidationNoticeArizona"},"seo":{"title":"debtValidationNoticeArizona"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"debtValidationNoticeArizona","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeArizona"},"children":[]}]}]}},{"type":"link","label":"debtValidationNoticeAutomatic","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticeautomatic","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticeautomatic","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDebtValidationNoticeAutomatic"},"seo":{"title":"debtValidationNoticeAutomatic"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"debtValidationNoticeAutomatic","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeAutomatic"},"children":[]}]}]}},{"type":"link","label":"debtValidationNoticeNYCYonkers","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticenycyonkers","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticenycyonkers","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDebtValidationNoticeNYCYonkers"},"seo":{"title":"debtValidationNoticeNYCYonkers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"debtValidationNoticeNYCYonkers","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeNYCYonkers"},"children":[]}]}]}},{"type":"link","label":"debtValidationNoticePuertoRico","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticepuertorico","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticepuertorico","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDebtValidationNoticePuertoRico"},"seo":{"title":"debtValidationNoticePuertoRico"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"debtValidationNoticePuertoRico","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticePuertoRico"},"children":[]}]}]}},{"type":"link","label":"deceasedConfirmationOfPayoff","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasedconfirmationofpayoff","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasedconfirmationofpayoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDeceasedConfirmationOfPayoff"},"seo":{"title":"deceasedConfirmationOfPayoff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deceasedConfirmationOfPayoff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDeceasedConfirmationOfPayoff"},"children":[]}]}]}},{"type":"link","label":"deceasedNoticeToRepresentative","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednoticetorepresentative","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednoticetorepresentative","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDeceasedNoticeToRepresentative"},"seo":{"title":"deceasedNoticeToRepresentative"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deceasedNoticeToRepresentative","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDeceasedNoticeToRepresentative"},"children":[]}]}]}},{"type":"link","label":"deceasedNotificationUponDeath","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednotificationupondeath","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednotificationupondeath","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDeceasedNotificationUponDeath"},"seo":{"title":"deceasedNotificationUponDeath"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deceasedNotificationUponDeath","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDeceasedNotificationUponDeath"},"children":[]}]}]}},{"type":"link","label":"disputeOfDebtConfirmed","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtconfirmed","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtconfirmed","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDisputeOfDebtConfirmed"},"seo":{"title":"disputeOfDebtConfirmed"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disputeOfDebtConfirmed","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtConfirmed"},"children":[]}]}]}},{"type":"link","label":"disputeOfDebtSubmitDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentation"},"seo":{"title":"disputeOfDebtSubmitDocumentation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disputeOfDebtSubmitDocumentation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentation"},"children":[]}]}]}},{"type":"link","label":"disputeOfDebtSubmitDocumentationReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentationreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentationreminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentationReminder"},"seo":{"title":"disputeOfDebtSubmitDocumentationReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disputeOfDebtSubmitDocumentationReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentationReminder"},"children":[]}]}]}},{"type":"link","label":"disputeOfDebtUnableToConfirm","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoconfirm","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoconfirm","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDisputeOfDebtUnableToConfirm"},"seo":{"title":"disputeOfDebtUnableToConfirm"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disputeOfDebtUnableToConfirm","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToConfirm"},"children":[]}]}]}},{"type":"link","label":"disputeOfDebtUnableToResolve","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoresolve","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoresolve","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectDisputeOfDebtUnableToResolve"},"seo":{"title":"disputeOfDebtUnableToResolve"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disputeOfDebtUnableToResolve","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToResolve"},"children":[]}]}]}},{"type":"link","label":"electronicConsentOptOut","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectelectronicconsentoptout","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectelectronicconsentoptout","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectElectronicConsentOptOut"},"seo":{"title":"electronicConsentOptOut"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"electronicConsentOptOut","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectElectronicConsentOptOut"},"children":[]}]}]}},{"type":"link","label":"failedSettlementInvestor","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfailedsettlementinvestor","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfailedsettlementinvestor","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectFailedSettlementInvestor"},"seo":{"title":"failedSettlementInvestor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"failedSettlementInvestor","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectFailedSettlementInvestor"},"children":[]}]}]}},{"type":"link","label":"freeFormBranded","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfreeformbranded","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfreeformbranded","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectFreeFormBranded"},"seo":{"title":"freeFormBranded"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"freeFormBranded","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectFreeFormBranded"},"children":[]}]}]}},{"type":"link","label":"futurepayCanceledf","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaycanceled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaycanceled","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectFuturepayCanceled"},"seo":{"title":"futurepayCanceledf"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"futurepayCanceledf","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectFuturepayCanceled"},"children":[]}]}]}},{"type":"link","label":"futurepayPaymentDueReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaypaymentduereminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaypaymentduereminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectFuturepayPaymentDueReminder"},"seo":{"title":"futurepayPaymentDueReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"futurepayPaymentDueReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectFuturepayPaymentDueReminder"},"children":[]}]}]}},{"type":"link","label":"identityTheftIncompleteDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftincompletedocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftincompletedocumentation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftIncompleteDocumentation"},"seo":{"title":"identityTheftIncompleteDocumentation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftIncompleteDocumentation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftIncompleteDocumentation"},"children":[]}]}]}},{"type":"link","label":"identityTheftNotValidated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftnotvalidated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftnotvalidated","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftNotValidated"},"seo":{"title":"identityTheftNotValidated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftNotValidated","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftNotValidated"},"children":[]}]}]}},{"type":"link","label":"identityTheftSubmitDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftSubmitDocumentation"},"seo":{"title":"identityTheftSubmitDocumentation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftSubmitDocumentation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentation"},"children":[]}]}]}},{"type":"link","label":"identityTheftSubmitDocumentationFirstReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationfirstreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationfirstreminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationFirstReminder"},"seo":{"title":"identityTheftSubmitDocumentationFirstReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftSubmitDocumentationFirstReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationFirstReminder"},"children":[]}]}]}},{"type":"link","label":"identityTheftSubmitDocumentationSecondReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationsecondreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationsecondreminder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationSecondReminder"},"seo":{"title":"identityTheftSubmitDocumentationSecondReminder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftSubmitDocumentationSecondReminder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationSecondReminder"},"children":[]}]}]}},{"type":"link","label":"identityTheftValidated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftvalidated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftvalidated","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AvailableTemplateContextSubjectIdentityTheftValidated"},"seo":{"title":"identityTheftValidated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identityTheftValidated","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftValidated"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"System Sent Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System Sent Messages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach automatically sends messages on your behalf. For example when autopay is enabled for a borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a message with subject "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"autopayAmountChanged","link":"/system-sent-messages/availabletemplatecontextsubjectautopayamountchanged","deprecated":false},{"title":"autopayCanceledBySystem","link":"/system-sent-messages/availabletemplatecontextsubjectautopaycanceledbysystem","deprecated":false},{"title":"autopayEnabled","link":"/system-sent-messages/availabletemplatecontextsubjectautopayenabled","deprecated":false},{"title":"autopayEnableReminder","link":"/system-sent-messages/availabletemplatecontextsubjectautopayenablereminder","deprecated":false},{"title":"autopayPaymentCanceled","link":"/system-sent-messages/availabletemplatecontextsubjectautopaypaymentcanceled","deprecated":false},{"title":"autopayPaymentMethodUpdated","link":"/system-sent-messages/availabletemplatecontextsubjectautopaypaymentmethodupdated","deprecated":false},{"title":"autopayPaymentReminder","link":"/system-sent-messages/availabletemplatecontextsubjectautopaypaymentreminder","deprecated":false},{"title":"autopayPaymentRescheduled","link":"/system-sent-messages/availabletemplatecontextsubjectautopaypaymentrescheduled","deprecated":false},{"title":"cardExpiresReminder","link":"/system-sent-messages/availabletemplatecontextsubjectcardexpiresreminder","deprecated":false},{"title":"ceaseCommunicationAcknowledgement","link":"/system-sent-messages/availabletemplatecontextsubjectceasecommunicationacknowledgement","deprecated":false},{"title":"ceaseCommunicationRefuseToPay","link":"/system-sent-messages/availabletemplatecontextsubjectceaserefusetopay","deprecated":false},{"title":"confirmationCode","link":"/system-sent-messages/availabletemplatecontextsubjectconfirmationcode","deprecated":false},{"title":"contactTakeover","link":"/system-sent-messages/availabletemplatecontextsubjectcontacttakeover","deprecated":false},{"title":"customX","link":"/system-sent-messages/availabletemplatecontextsubjectcustomx","deprecated":false},{"title":"debtValidationNotice","link":"/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnotice","deprecated":false},{"title":"debtValidationNoticeArizona","link":"/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticearizona","deprecated":false},{"title":"debtValidationNoticeAutomatic","link":"/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticeautomatic","deprecated":false},{"title":"debtValidationNoticeNYCYonkers","link":"/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticenycyonkers","deprecated":false},{"title":"debtValidationNoticePuertoRico","link":"/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticepuertorico","deprecated":false},{"title":"deceasedConfirmationOfPayoff","link":"/system-sent-messages/availabletemplatecontextsubjectdeceasedconfirmationofpayoff","deprecated":false},{"title":"deceasedNoticeToRepresentative","link":"/system-sent-messages/availabletemplatecontextsubjectdeceasednoticetorepresentative","deprecated":false},{"title":"deceasedNotificationUponDeath","link":"/system-sent-messages/availabletemplatecontextsubjectdeceasednotificationupondeath","deprecated":false},{"title":"disputeOfDebtConfirmed","link":"/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtconfirmed","deprecated":false},{"title":"disputeOfDebtSubmitDocumentation","link":"/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentation","deprecated":false},{"title":"disputeOfDebtSubmitDocumentationReminder","link":"/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentationreminder","deprecated":false},{"title":"disputeOfDebtUnableToConfirm","link":"/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoconfirm","deprecated":false},{"title":"disputeOfDebtUnableToResolve","link":"/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoresolve","deprecated":false},{"title":"electronicConsentOptOut","link":"/system-sent-messages/availabletemplatecontextsubjectelectronicconsentoptout","deprecated":false},{"title":"failedSettlementInvestor","link":"/system-sent-messages/availabletemplatecontextsubjectfailedsettlementinvestor","deprecated":false},{"title":"freeFormBranded","link":"/system-sent-messages/availabletemplatecontextsubjectfreeformbranded","deprecated":false},{"title":"futurepayCanceledf","link":"/system-sent-messages/availabletemplatecontextsubjectfuturepaycanceled","deprecated":false},{"title":"futurepayPaymentDueReminder","link":"/system-sent-messages/availabletemplatecontextsubjectfuturepaypaymentduereminder","deprecated":false},{"title":"identityTheftIncompleteDocumentation","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftincompletedocumentation","deprecated":false},{"title":"identityTheftNotValidated","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftnotvalidated","deprecated":false},{"title":"identityTheftSubmitDocumentation","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentation","deprecated":false},{"title":"identityTheftSubmitDocumentationFirstReminder","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationfirstreminder","deprecated":false},{"title":"identityTheftSubmitDocumentationSecondReminder","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationsecondreminder","deprecated":false},{"title":"identityTheftValidated","link":"/system-sent-messages/availabletemplatecontextsubjectidentitytheftvalidated","deprecated":false}]}]}]}]}},{"type":"group","label":"Interactions","link":"/api-docs/api-public/interactions","routeSlug":"/api-docs/api-public/interactions","items":[{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","name":"Get interaction call summaries","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction call summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"status","in":"query","schemaId":"schema_5918","description":"The status of the transcription result.\n"},{"name":"aICallTranscriptionResultId","in":"query","schemaId":"components/schemas/newStatus","description":"Filter by the AI Call Transcription Result ID.\n"}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/interactions/{interactionId}/call-transcripts/summaries","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"status","in":"query","required":false,"schemaId":"schema_5918"},{"name":"aICallTranscriptionResultId","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/interactions/{interactionId}/call-transcripts/summaries","href":"interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","openApiOperationId":"peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","summary":"Get interaction call summaries","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}},"schemaId":"components/schemas/CallSummaryResultsPaging"}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallSummaryResultsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction"}],"panels":[]}]},"httpPath":"/companies/{companyId}/interactions/{interactionId}/call-transcripts/summaries"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","name":"Get previous interactions","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1previous/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get previous interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this interaction, get all the previous interactions linked to it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousInteractionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1previous/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_5919","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional interaction relationships to include in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is data describing the borrower associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact`` field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null`). This is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact data for the contact this interaction was sent to or from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is meta data about the most recently ended task associated with this interaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include multiple fields by passing multiple values, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower,contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1previous/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/interactions/{interactionId}/previous","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_5919"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/interactions/{interactionId}/previous","href":"interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","openApiOperationId":"peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","summary":"Get previous interactions","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}},"schemaId":"components/schemas/InteractionsManyNoPaging"}],"pointer":"/paths/~1companies~1{companyId}~1interactions~1{interactionId}~1previous/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InteractionsManyNoPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions"}],"panels":[]}]},"httpPath":"/companies/{companyId}/interactions/{interactionId}/previous"},{"label":"Get interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_all","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_all","metadata":{"seo":{"title":"Get interactions","description":"Get interactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.unbound_interaction_get_all","name":"Get interactions","isWebhook":false,"pointer":"/paths/~1interactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"hasNoPerson","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only unassociated interactions—those not associated with a borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions associated with a borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, include any interaction regardless of it being associated with a borrower or not."},"children":[]}]}]}]},{"name":"channel","in":"query","schemaId":"schema_5687","description":"Exactly match the channel over which the interaction took place.\n"},{"name":"direction","in":"query","schemaId":"schema_5920","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly match the direction the interaction—either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_5686","description":"Exactly match the status of an interaction.\n"},{"name":"statusDetails","in":"query","schemaId":"schema_5921","description":"Exactly match the status details of an interaction.\n"},{"name":"agentOutcome","in":"query","schemaId":"schema_5922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an interaction."},"children":[]}]}]}]},{"name":"subject","in":"query","schemaId":"schema_5632","description":"The interaction subject value(s) by which to filter. To match interactions\nwithout a subject pass the string \"null\".\n"},{"name":"theme","in":"query","schemaId":"schema_5923"},{"name":"caseIds","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches one of several Peach case IDs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CS-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"contentContains","in":"query","schemaId":"components/schemas/newStatus","description":"Search for an exact match in the content of the interaction\n"},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"startedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not started at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"startedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not started at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to before (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to after (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to before (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to after (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"createdBy","in":"query","schemaId":"schema_5924","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The User ID or Employee ID of the user which created the interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified then match all interactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"hasVoicemail","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with voicemails—only valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions without voicemails."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, then include any interaction regardless of it having voicemail or not."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a voicemail is different from a call recording. A voicemail is an audio message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"left by a caller when no pickup by the company was possible. e.g., the call was made while the office was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"closed or while there were no agents available to answer the call."},"children":[]}]}]}]},{"name":"hasRecording","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only interactions with call recordings—only valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only interactions without call recordings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, match any interaction regardless of it have a recording or not."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a call recording is when an agent chooses to record a call, which is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different from a voicemail."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_5919","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional interaction relationships to include in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is data describing the borrower associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact`` field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null`). This is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact data for the contact this interaction was sent to or from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is meta data about the most recently ended task associated with this interaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include multiple fields by passing multiple values, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower,contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sensitive","in":"query","schemaId":"schema_5757","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, include any interaction regardless of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},{"name":"isExternal","in":"query","schemaId":"schema_5757","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, include any interaction regardless of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"hasNoPerson","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"channel","in":"query","required":false,"schemaId":"schema_5687"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/InteractionDirection"},{"name":"status","in":"query","required":false,"schemaId":"schema_5686"},{"name":"statusDetails","in":"query","required":false,"schemaId":"schema_5921"},{"name":"agentOutcome","in":"query","required":false,"schemaId":"schema_5922"},{"name":"subject","in":"query","required":false,"schemaId":"schema_5632"},{"name":"theme","in":"query","required":false,"schemaId":"schema_5923"},{"name":"caseIds","in":"query","required":false,"schemaId":"schema_5632"},{"name":"contentContains","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"startedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"startedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdBy","in":"query","required":false,"schemaId":"schema_5924"},{"name":"hasVoicemail","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"hasRecording","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"include","in":"query","required":false,"schemaId":"schema_5919"},{"name":"sensitive","in":"query","required":false,"schemaId":"schema_5757"},{"name":"isExternal","in":"query","required":false,"schemaId":"schema_5757"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions","href":"interactions/peach.people.interaction.handlers.unbound_interaction_get_all","openApiOperationId":"peach.people.interaction.handlers.unbound_interaction_get_all","summary":"Get interactions","securityGroups":[{"oauth2":["interaction:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsPaging"}},"schemaId":"components/schemas/InteractionsPaging"}],"pointer":"/paths/~1interactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InteractionsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.unbound_interaction_get_all"}],"panels":[]}]},"httpPath":"/interactions"},{"label":"Get interaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","metadata":{"seo":{"title":"Get interaction by ID","description":"Get interaction by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.unbound_interaction_get_by_id","name":"Get interaction by ID","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions~1{interactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}","href":"interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","openApiOperationId":"peach.people.interaction.handlers.unbound_interaction_get_by_id","summary":"Get interaction by ID","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}},"schemaId":"schema_5896"}],"pointer":"/paths/~1interactions~1{interactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}"},{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","name":"Get interaction call summaries","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1call-transcripts~1summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction call summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"status","in":"query","schemaId":"schema_5918","description":"The status of the transcription result.\n"},{"name":"aICallTranscriptionResultId","in":"query","schemaId":"components/schemas/newStatus","description":"Filter by the AI Call Transcription Result ID.\n"}],"pointer":"/paths/~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/call-transcripts/summaries","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"status","in":"query","required":false,"schemaId":"schema_5918"},{"name":"aICallTranscriptionResultId","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/call-transcripts/summaries","href":"interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","openApiOperationId":"peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","summary":"Get interaction call summaries","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}},"schemaId":"components/schemas/CallSummaryResultsPaging"}],"pointer":"/paths/~1interactions~1{interactionId}~1call-transcripts~1summaries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallSummaryResultsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/call-transcripts/summaries"},{"label":"Get interaction convo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_get","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_get","metadata":{"seo":{"title":"Get interaction convo","description":"Get interaction convo"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.convo.handlers_api.interaction_convo_get","name":"Get interaction convo","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1convo/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction convo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["conversation:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1convo/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/convo","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["conversation:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/convo","href":"interactions/peach.twilio.convo.handlers_api.interaction_convo_get","openApiOperationId":"peach.twilio.convo.handlers_api.interaction_convo_get","summary":"Get interaction convo","securityGroups":[{"oauth2":["conversation:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1interactions~1{interactionId}~1convo/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_get"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/convo"},{"label":"Close interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_close","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_close","metadata":{"seo":{"title":"Close interaction convo","description":"Close interaction convo"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.convo.handlers_api.interaction_convo_close","name":"Close interaction convo","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1convo~1close/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close interaction convo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["conversation:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1close/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/interactions/{interactionId}/convo/close","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["conversation:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/convo/close","href":"interactions/peach.twilio.convo.handlers_api.interaction_convo_close","openApiOperationId":"peach.twilio.convo.handlers_api.interaction_convo_close","summary":"Close interaction convo","securityGroups":[{"oauth2":["conversation:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1close/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_close"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/convo/close"},{"label":"Join interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_join","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_join","metadata":{"seo":{"title":"Join interaction convo","description":"Add the user making the request to the conversation associated with this interaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.convo.handlers_api.interaction_convo_join","name":"Join interaction convo","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1convo~1join/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Join interaction convo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add the user making the request to the conversation associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only users of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can join conversations. (i.e., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"users cannot join conversations.)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["conversation:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1join/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5925"}},"schemaId":"schema_5925","pointer":"/paths/~1interactions~1{interactionId}~1convo~1join/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/interactions/{interactionId}/convo/join","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["conversation:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5925"}},"responseCodes":["200"],"pointer":"/interactions/{interactionId}/convo/join","href":"interactions/peach.twilio.convo.handlers_api.interaction_convo_join","openApiOperationId":"peach.twilio.convo.handlers_api.interaction_convo_join","summary":"Join interaction convo","securityGroups":[{"oauth2":["conversation:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5925","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5925"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1join/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_join"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/convo/join"},{"label":"Leave interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","metadata":{"seo":{"title":"Leave interaction convo","description":"Leave interaction convo"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.twilio.convo.handlers_api.interaction_convo_leave","name":"Leave interaction convo","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1convo~1leave/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Leave interaction convo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["conversation:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1leave/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/interactions/{interactionId}/convo/leave","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["conversation:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/convo/leave","href":"interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","openApiOperationId":"peach.twilio.convo.handlers_api.interaction_convo_leave","summary":"Leave interaction convo","securityGroups":[{"oauth2":["conversation:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1interactions~1{interactionId}~1convo~1leave/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/convo/leave"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.unbound_get_many_previous_interactions","name":"Get previous interactions","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1previous/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get previous interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this interaction, get all the previous interactions linked to it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousInteractionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1previous/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_5919","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional interaction relationships to include in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is data describing the borrower associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact`` field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null`). This is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact data for the contact this interaction was sent to or from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is meta data about the most recently ended task associated with this interaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include multiple fields by passing multiple values, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower,contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions~1{interactionId}~1previous/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/previous","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_5919"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/interactions/{interactionId}/previous","href":"interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","openApiOperationId":"peach.people.interaction.handlers.unbound_get_many_previous_interactions","summary":"Get previous interactions","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}},"schemaId":"components/schemas/InteractionsManyNoPaging"}],"pointer":"/paths/~1interactions~1{interactionId}~1previous/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InteractionsManyNoPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/previous"},{"label":"Download interaction recording","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","metadata":{"seo":{"title":"Download interaction recording","description":"Download interaction recording"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.unbound_interaction_download_recording","name":"Download interaction recording","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1recording-content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download interaction recording","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1recording-content/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"disposition","in":"query","schemaId":"schema_5660","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tells the response from the file download to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the given value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"download the file\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"open the file in the default manner\". e.g., if the file were an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".mp3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the browser's default audio player would open."},"children":[]}]}]}]}]},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the content instead of redirecting to the content."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions~1{interactionId}~1recording-content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/recording-content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"disposition","in":"query","schemaId":"schema_5660"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","302"],"pointer":"/interactions/{interactionId}/recording-content","href":"interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","openApiOperationId":"peach.people.interaction.handlers.unbound_interaction_download_recording","summary":"Download interaction recording","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then return the url rather than redirecting."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}},"schemaId":"schema_5926"},{"code":"302","description":"Redirected to the recorded content"}],"pointer":"/paths/~1interactions~1{interactionId}~1recording-content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5926","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}}},{"code":"302"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/recording-content"},{"label":"Download interaction voicemail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","metadata":{"seo":{"title":"Download interaction voicemail","description":"Download interaction voicemail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.unbound_interaction_download_voicemail","name":"Download interaction voicemail","isWebhook":false,"pointer":"/paths/~1interactions~1{interactionId}~1voicemail-content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download interaction voicemail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1interactions~1{interactionId}~1voicemail-content/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"disposition","in":"query","schemaId":"schema_5660","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tells the response from the file download to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the given value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"download the file\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"open the file in the default manner\". e.g., if the file were an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".mp3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the browser's default audio player would open."},"children":[]}]}]}]}]},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the content instead of redirecting to the content."},"children":[]}]}]}]}],"pointer":"/paths/~1interactions~1{interactionId}~1voicemail-content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/interactions/{interactionId}/voicemail-content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"disposition","in":"query","schemaId":"schema_5660"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","302"],"pointer":"/interactions/{interactionId}/voicemail-content","href":"interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","openApiOperationId":"peach.people.interaction.handlers.unbound_interaction_download_voicemail","summary":"Download interaction voicemail","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then return the url rather than redirecting."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}},"schemaId":"schema_5926"},{"code":"302","description":"Redirected to the recorded content"}],"pointer":"/paths/~1interactions~1{interactionId}~1voicemail-content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5926","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}}},{"code":"302"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail"}],"panels":[]}]},"httpPath":"/interactions/{interactionId}/voicemail-content"},{"label":"Get borrower interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_all","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_all","metadata":{"seo":{"title":"Get borrower interactions","description":"Get borrower interactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_get_all","name":"Get borrower interactions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get borrower interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"channel","in":"query","schemaId":"schema_5687","description":"Exactly match the channel over which the interaction took place.\n"},{"name":"direction","in":"query","schemaId":"schema_5920","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly match the direction the interaction—either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_5686","description":"Exactly match the status of an interaction.\n"},{"name":"statusDetails","in":"query","schemaId":"schema_5921","description":"Exactly match the status details of an interaction.\n"},{"name":"agentOutcome","in":"query","schemaId":"schema_5922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an interaction."},"children":[]}]}]}]},{"name":"subject","in":"query","schemaId":"schema_5632","description":"The interaction subject value(s) by which to filter. To match interactions\nwithout a subject pass the string \"null\".\n"},{"name":"theme","in":"query","schemaId":"schema_5923"},{"name":"caseIds","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly matches one of several Peach case IDs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CS-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"contentContains","in":"query","schemaId":"components/schemas/newStatus","description":"Search for an exact match in the content of the interaction\n"},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field(s) to sort by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields can be prefixed with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the sort should be in descending order,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the sort should be in ascending order. (Without specifying"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order is descending.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The valid sort by field names are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the object creation order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the duration of the voice call on-hold (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the contact for the interaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeFirstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the employee which created the interaction (only if creator was an employee)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeLastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the employee which created the interaction (only if creator was an employee)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — order by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the employee which created the interaction (only if creator was an employee)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeDisplayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - order by the full name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{firstName} {lastName}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or, if absent, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the employee whihch created the interaction (only if creator was an employee)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeFullNameOrEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alias for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy.employeeDisplayName"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_5919","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional interaction relationships to include in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is data describing the borrower associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact`` field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null`). This is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact data for the contact this interaction was sent to or from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is meta data about the most recently ended task associated with this interaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include multiple fields by passing multiple values, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower,contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not created at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"startedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not started at or before the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"startedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Filter only objects that were not started at or after the specified\ntimestamp. This timestamp is in UTC.\n"},{"name":"scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to before (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to after (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to before (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include only interactions which have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledAtTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to after (or equal to) this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}]},{"name":"createdBy","in":"query","schemaId":"schema_5924","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The User ID or Employee ID of the user which created the interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified then match all interactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"hasVoicemail","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with voicemails—only valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions without voicemails."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, then include any interaction regardless of it having voicemail or not."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a voicemail is different from a call recording. A voicemail is an audio message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"left by a caller when no pickup by the company was possible. e.g., the call was made while the office was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"closed or while there were no agents available to answer the call."},"children":[]}]}]}]},{"name":"hasRecording","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only interactions with call recordings—only valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only interactions without call recordings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, match any interaction regardless of it have a recording or not."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a call recording is when an agent chooses to record a call, which is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different from a voicemail."},"children":[]}]}]}]},{"name":"sensitive","in":"query","schemaId":"schema_5757","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, include any interaction regardless of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},{"name":"isExternal","in":"query","schemaId":"schema_5757","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include only interactions with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unset, include any interaction regardless of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"channel","in":"query","required":false,"schemaId":"schema_5687"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/InteractionDirection"},{"name":"status","in":"query","required":false,"schemaId":"schema_5686"},{"name":"statusDetails","in":"query","required":false,"schemaId":"schema_5921"},{"name":"agentOutcome","in":"query","required":false,"schemaId":"schema_5922"},{"name":"subject","in":"query","required":false,"schemaId":"schema_5632"},{"name":"theme","in":"query","required":false,"schemaId":"schema_5923"},{"name":"caseIds","in":"query","required":false,"schemaId":"schema_5632"},{"name":"contentContains","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"include","in":"query","required":false,"schemaId":"schema_5919"},{"name":"createdAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"startedAtBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"startedAtAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtFromBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtFromAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtToBefore","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"scheduledAtToAfter","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdBy","in":"query","required":false,"schemaId":"schema_5924"},{"name":"hasVoicemail","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"hasRecording","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"sensitive","in":"query","required":false,"schemaId":"schema_5757"},{"name":"isExternal","in":"query","required":false,"schemaId":"schema_5757"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions","href":"interactions/peach.people.interaction.handlers.interaction_get_all","openApiOperationId":"peach.people.interaction.handlers.interaction_get_all","summary":"Get borrower interactions","securityGroups":[{"oauth2":["interaction:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsPaging"}},"schemaId":"components/schemas/InteractionsPaging"}],"pointer":"/paths/~1people~1{personId}~1interactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InteractionsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_get_all"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions"},{"label":"Create interaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_add","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_add","metadata":{"seo":{"title":"Create interaction","description":"Creating interactions tracks the history of communication between lenders/servicers and borrowers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_add","name":"Create interaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating interactions tracks the history of communication between lenders/servicers and borrowers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this does NOT send a message—merely tracks that it occurred. If you need to send a message, use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communicator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5927"}},"schemaId":"schema_5927","pointer":"/paths/~1people~1{personId}~1interactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/interactions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5927"}},"responseCodes":["200"],"pointer":"/people/{personId}/interactions","href":"interactions/peach.people.interaction.handlers.interaction_add","openApiOperationId":"peach.people.interaction.handlers.interaction_add","summary":"Create interaction","securityGroups":[{"oauth2":["interaction:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5927","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5927"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}},"schemaId":"schema_5896"}],"pointer":"/paths/~1people~1{personId}~1interactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_add"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions"},{"label":"Delete interaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_delete","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_delete","metadata":{"seo":{"title":"Delete interaction","description":"Delete an interaction. Only external interactions (interactions created by lenders via API) can be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_delete","name":"Delete interaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an interaction. Only external interactions (interactions created\nby lenders via API) can be deleted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people/{personId}/interactions/{interactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}","href":"interactions/peach.people.interaction.handlers.interaction_delete","openApiOperationId":"peach.people.interaction.handlers.interaction_delete","summary":"Delete interaction","securityGroups":[{"oauth2":["interaction:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_delete"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}"},{"label":"Get interaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_by_id","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_by_id","metadata":{"seo":{"title":"Get interaction by ID","description":"Get interaction by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_get_by_id","name":"Get interaction by ID","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchable","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", format the entire response as one suitable for an ElasticSearch search index."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"searchable","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}","href":"interactions/peach.people.interaction.handlers.interaction_get_by_id","openApiOperationId":"peach.people.interaction.handlers.interaction_get_by_id","summary":"Get interaction by ID","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}},"schemaId":"schema_5896"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_get_by_id"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}"},{"label":"Update interaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_update","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_update","metadata":{"seo":{"title":"Update interaction","description":"Update interaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_update","name":"Update interaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Interaction"}},"schemaId":"components/schemas/Interaction","pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people/{personId}/interactions/{interactionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Interaction"}},"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}","href":"interactions/peach.people.interaction.handlers.interaction_update","openApiOperationId":"peach.people.interaction.handlers.interaction_update","summary":"Update interaction","securityGroups":[{"oauth2":["interaction:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Interaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Interaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}},"schemaId":"schema_5896"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5896"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_update"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}"},{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","name":"Get interaction call summaries","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get interaction call summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"status","in":"query","schemaId":"schema_5918","description":"The status of the transcription result.\n"},{"name":"aICallTranscriptionResultId","in":"query","schemaId":"components/schemas/newStatus","description":"Filter by the AI Call Transcription Result ID.\n"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}/call-transcripts/summaries","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"status","in":"query","required":false,"schemaId":"schema_5918"},{"name":"aICallTranscriptionResultId","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}/call-transcripts/summaries","href":"interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","openApiOperationId":"peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","summary":"Get interaction call summaries","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}},"schemaId":"components/schemas/CallSummaryResultsPaging"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1call-transcripts~1summaries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallSummaryResultsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallSummaryResultsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}/call-transcripts/summaries"},{"label":"Get cases associated with an interaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_interaction_cases","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_interaction_cases","metadata":{"seo":{"title":"Get cases associated with an interaction","description":"Get cases associated with an interaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.get_interaction_cases","name":"Get cases associated with an interaction","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1cases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cases associated with an interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["case:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1cases/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1cases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}/cases","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["case:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}/cases","href":"interactions/peach.people.interaction.handlers.get_interaction_cases","openApiOperationId":"peach.people.interaction.handlers.get_interaction_cases","summary":"Get cases associated with an interaction","securityGroups":[{"oauth2":["case:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}},"schemaId":"schema_5688"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1cases/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5688"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.get_interaction_cases"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}/cases"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.get_many_previous_interactions","name":"Get previous interactions","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1previous/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get previous interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this interaction, get all the previous interactions linked to it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousInteractionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1previous/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_5919","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional interaction relationships to include in the response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is data describing the borrower associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact`` field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null`). This is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact data for the contact this interaction was sent to or from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTaskMeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be populated (otherwise it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is meta data about the most recently ended task associated with this interaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include multiple fields by passing multiple values, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=borrower,contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1previous/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}/previous","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_5919"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/people/{personId}/interactions/{interactionId}/previous","href":"interactions/peach.people.interaction.handlers.get_many_previous_interactions","openApiOperationId":"peach.people.interaction.handlers.get_many_previous_interactions","summary":"Get previous interactions","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}},"schemaId":"components/schemas/InteractionsManyNoPaging"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1previous/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InteractionsManyNoPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InteractionsManyNoPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.get_many_previous_interactions"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}/previous"},{"label":"Download interaction recording","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_recording","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_recording","metadata":{"seo":{"title":"Download interaction recording","description":"Download interaction recording"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_download_recording","name":"Download interaction recording","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1recording-content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download interaction recording","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1recording-content/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"disposition","in":"query","schemaId":"schema_5660","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tells the response from the file download to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the given value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"download the file\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"open the file in the default manner\". e.g., if the file were an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".mp3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the browser's default audio player would open."},"children":[]}]}]}]}]},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the content instead of redirecting to the content."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1recording-content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}/recording-content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"disposition","in":"query","schemaId":"schema_5660"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","302"],"pointer":"/people/{personId}/interactions/{interactionId}/recording-content","href":"interactions/peach.people.interaction.handlers.interaction_download_recording","openApiOperationId":"peach.people.interaction.handlers.interaction_download_recording","summary":"Download interaction recording","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then return the url rather than redirecting."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}},"schemaId":"schema_5926"},{"code":"302","description":"Redirected to the recorded content"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1recording-content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5926","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}}},{"code":"302"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_download_recording"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}/recording-content"},{"label":"Download interaction voicemail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_voicemail","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_voicemail","metadata":{"seo":{"title":"Download interaction voicemail","description":"Download interaction voicemail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.interaction.handlers.interaction_download_voicemail","name":"Download interaction voicemail","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1voicemail-content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download interaction voicemail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"interactionId","in":"path","schemaId":"schema_5625","description":"Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1voicemail-content/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"disposition","in":"query","schemaId":"schema_5660","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tells the response from the file download to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the given value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"download the file\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"open the file in the default manner\". e.g., if the file were an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".mp3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the browser's default audio player would open."},"children":[]}]}]}]}]},{"name":"returnUrl","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will return a URL to the content instead of redirecting to the content."},"children":[]}]}]}]}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1voicemail-content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{personId}/interactions/{interactionId}/voicemail-content","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"interactionId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"disposition","in":"query","schemaId":"schema_5660"},{"name":"returnUrl","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","302"],"pointer":"/people/{personId}/interactions/{interactionId}/voicemail-content","href":"interactions/peach.people.interaction.handlers.interaction_download_voicemail","openApiOperationId":"peach.people.interaction.handlers.interaction_download_voicemail","summary":"Download interaction voicemail","securityGroups":[{"oauth2":["interaction:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then return the url rather than redirecting."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}},"schemaId":"schema_5926"},{"code":"302","description":"Redirected to the recorded content"}],"pointer":"/paths/~1people~1{personId}~1interactions~1{interactionId}~1voicemail-content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5926","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5926"}}},{"code":"302"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/peach.people.interaction.handlers.interaction_download_voicemail"}],"panels":[]}]},"httpPath":"/people/{personId}/interactions/{interactionId}/voicemail-content"}],"content":{"contentType":"group","meta":{"name":"Interactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Interactions","showPageActions":true},{"nodeType":"markdoc","content":"Interactions represent communications with a borrower.\n\nWhenever Peach communicates with a borrower an interaction is recorded.\n\nAdditionally, communications taking place outside of Peach  should be recorded\nas interactions.\n\nPast interactions information is used by Compliance Guard to make decisions\nabout when and how it is appropriate to communicate again with a borrower."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/interactions/{interactionId}/call-transcripts/summaries","summary":"Get interaction call summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","deprecated":false},{"title":"/companies/{companyId}/interactions/{interactionId}/previous","summary":"Get previous interactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","deprecated":false},{"title":"/interactions","summary":"Get interactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.unbound_interaction_get_all","deprecated":false},{"title":"/interactions/{interactionId}","summary":"Get interaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","deprecated":false},{"title":"/interactions/{interactionId}/call-transcripts/summaries","summary":"Get interaction call summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","deprecated":false},{"title":"/interactions/{interactionId}/convo","summary":"Get interaction convo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_get","deprecated":false},{"title":"/interactions/{interactionId}/convo/close","summary":"Close interaction convo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_close","deprecated":false},{"title":"/interactions/{interactionId}/convo/join","summary":"Join interaction convo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_join","deprecated":false},{"title":"/interactions/{interactionId}/convo/leave","summary":"Leave interaction convo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","deprecated":false},{"title":"/interactions/{interactionId}/previous","summary":"Get previous interactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","deprecated":false},{"title":"/interactions/{interactionId}/recording-content","summary":"Download interaction recording","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","deprecated":false},{"title":"/interactions/{interactionId}/voicemail-content","summary":"Download interaction voicemail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","deprecated":false},{"title":"/people/{personId}/interactions","summary":"Get borrower interactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_get_all","deprecated":false},{"title":"/people/{personId}/interactions","summary":"Create interaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_add","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}","summary":"Delete interaction","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_delete","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}","summary":"Get interaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_get_by_id","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}","summary":"Update interaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_update","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}/call-transcripts/summaries","summary":"Get interaction call summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}/cases","summary":"Get cases associated with an interaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.get_interaction_cases","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}/previous","summary":"Get previous interactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.get_many_previous_interactions","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}/recording-content","summary":"Download interaction recording","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_download_recording","deprecated":false},{"title":"/people/{personId}/interactions/{interactionId}/voicemail-content","summary":"Download interaction voicemail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/interactions/peach.people.interaction.handlers.interaction_download_voicemail","deprecated":false}]}]}]}]}},{"type":"group","label":"Compliance Guard","link":"/api-docs/api-public/compliance-guard","routeSlug":"/api-docs/api-public/compliance-guard","items":[{"label":"Can interact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact","routeSlug":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact","metadata":{"seo":{"title":"Can interact","description":"Returns whether or not a communication is allowed with a borrower."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.handlers.can_interact","name":"Can interact","isWebhook":false,"pointer":"/paths/~1people~1{personId}~1can-interact/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Can interact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns whether or not a communication is allowed with a borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It uses past interactions, current borrower status, loan status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and relevant Compliance Guard rules to make a decision if it is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissable to communicate with a borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note this endpoint always returns a 200 status code if we could successfully"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculate a result. (i.e., even if a communication is not permitted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response.)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["interaction:check"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true}],"pointer":"/paths/~1people~1{personId}~1can-interact/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CanInteractByContactIdentifier"}},"schemaId":"components/schemas/CanInteractByContactIdentifier","pointer":"/paths/~1people~1{personId}~1can-interact/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people/{personId}/can-interact","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["interaction:check"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CanInteractByContactIdentifier"}},"responseCodes":["200"],"pointer":"/people/{personId}/can-interact","href":"compliance-guard/peach.people.handlers.can_interact","openApiOperationId":"peach.people.handlers.can_interact","summary":"Can interact","securityGroups":[{"oauth2":["interaction:check"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CanInteractByContactIdentifier","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CanInteractByContactIdentifier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5928"}},"schemaId":"schema_5928"}],"pointer":"/paths/~1people~1{personId}~1can-interact/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5928","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5928"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/compliance-guard/peach.people.handlers.can_interact"}],"panels":[]}]},"httpPath":"/people/{personId}/can-interact"}],"content":{"contentType":"group","meta":{"name":"Compliance Guard"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compliance Guard","showPageActions":true},{"nodeType":"markdoc","content":"Compliance Guard helps ensures communications with borrowers are compliant with\nregulations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people/{personId}/can-interact","summary":"Can interact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/compliance-guard/peach.people.handlers.can_interact","deprecated":false}]}]}]}]}},{"type":"separator","label":"Promo Programs Management","content":null},{"type":"group","label":"Promo Programs Type","link":"/api-docs/api-public/promo-programs-type","routeSlug":"/api-docs/api-public/promo-programs-type","items":[{"label":"Get promo program types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","metadata":{"seo":{"title":"Get promo program types","description":"Get promo program types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","name":"Get promo program types","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get promo program types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram.type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_5929","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter promo program types by a single status. Prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts more than one value. If both are supplied, a promo program type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matches when its status is any of the values across both parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches types stored as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the legacy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"deprecated":true},{"name":"statuses","in":"query","schemaId":"schema_5930","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter promo program types by status. Repeat the parameter to match more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"than one status, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?statuses=draft&statuses=active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If omitted, promo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"program types in every status are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches types stored as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the legacy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"promoType","in":"query","schemaId":"schema_5931","description":"The promo type to filter by."},{"name":"search","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter promo program types to those whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the search term. Matching is case-insensitive and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matches anywhere within the value."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/promo-program-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_5929"},{"name":"statuses","in":"query","required":false,"schemaId":"schema_5930"},{"name":"promoType","in":"query","required":false,"schemaId":"schema_5931"},{"name":"search","in":"query","required":false,"schemaId":"components/schemas/newStatus"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram.type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/promo-program-types","href":"promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","openApiOperationId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","summary":"Get promo program types","securityGroups":[{"oauth2":["loan.promoprogram.type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePaging"}},"schemaId":"components/schemas/PromoProgramTypePaging"}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PromoProgramTypePaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all"}],"panels":[]}]},"httpPath":"/companies/{companyId}/promo-program-types"},{"label":"Create promo program type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","metadata":{"seo":{"title":"Create promo program type","description":"Create promo program type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","name":"Create promo program type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create promo program type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePost"}},"schemaId":"components/schemas/PromoProgramTypePost","pointer":"/paths/~1companies~1{companyId}~1promo-program-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/promo-program-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePost"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/promo-program-types","href":"promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","openApiOperationId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","summary":"Create promo program type","securityGroups":[{"oauth2":["loan.promoprogram.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramTypePost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}},"schemaId":"schema_5932"}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5932","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add"}],"panels":[]}]},"httpPath":"/companies/{companyId}/promo-program-types"},{"label":"Cancel promo program type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","metadata":{"seo":{"title":"Cancel promo program type","description":"Cancel promo program type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","name":"Cancel promo program type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel promo program type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram.type:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"promoProgramTypeId","in":"path","schemaId":"schema_5625","description":"The promotional program type identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"promoProgramTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram.type:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","href":"promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","openApiOperationId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","summary":"Cancel promo program type","securityGroups":[{"oauth2":["loan.promoprogram.type:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}"},{"label":"Get promo program type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","metadata":{"seo":{"title":"Get promo program type by ID","description":"Get promo program type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","name":"Get promo program type by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get promo program type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"promoProgramTypeId","in":"path","schemaId":"schema_5625","description":"The promotional program type identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"promoProgramTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","href":"promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","openApiOperationId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","summary":"Get promo program type by ID","securityGroups":[{"oauth2":["loan.promoprogram.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}},"schemaId":"schema_5932"}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5932","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}"},{"label":"Update promo program type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","metadata":{"seo":{"title":"Update promo program type","description":"Update promo program type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","name":"Update promo program type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update promo program type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.promoprogram.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"promoProgramTypeId","in":"path","schemaId":"schema_5625","description":"The promotional program type identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePut"}},"schemaId":"components/schemas/PromoProgramTypePut","pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"promoProgramTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.promoprogram.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePut"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","href":"promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","openApiOperationId":"peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","summary":"Update promo program type","securityGroups":[{"oauth2":["loan.promoprogram.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PromoProgramTypePut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromoProgramTypePut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}},"schemaId":"schema_5932"}],"pointer":"/paths/~1companies~1{companyId}~1promo-program-types~1{promoProgramTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5932","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5932"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}"}],"content":{"contentType":"group","meta":{"name":"Promo Programs Type"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Promo Programs Type","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/promo-program-types","summary":"Get promo program types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","deprecated":false},{"title":"/companies/{companyId}/promo-program-types","summary":"Create promo program type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","deprecated":false},{"title":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","summary":"Cancel promo program type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","deprecated":false},{"title":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","summary":"Get promo program type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","deprecated":false},{"title":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","summary":"Update promo program type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Processor Management","content":null},{"type":"group","label":"Payment Processors","link":"/api-docs/api-public/payment-processors","routeSlug":"/api-docs/api-public/payment-processors","items":[{"label":"Get payment processors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_payment_processors","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_payment_processors","metadata":{"seo":{"title":"Get payment processors","description":"Get payment processors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_processors.handlers.get_payment_processors","name":"Get payment processors","isWebhook":false,"pointer":"/paths/~1payment-processors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment processors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.processor:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"isSettlementRequired","in":"query","schemaId":"components/schemas/transactionIsExternal","description":"Filter payment processors by whether settlement is required. When omitted, processors are not filtered on this field."},{"name":"status","in":"query","schemaId":"components/schemas/VersionStatus","description":"Filter payment processors by status. When omitted, processors are not filtered on status (deprecated ones remain excluded)."}],"pointer":"/paths/~1payment-processors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-processors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"isSettlementRequired","in":"query","required":false,"schemaId":"components/schemas/transactionIsExternal"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/VersionStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.processor:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-processors","href":"payment-processors/peach.payment_processors.handlers.get_payment_processors","openApiOperationId":"peach.payment_processors.handlers.get_payment_processors","summary":"Get payment processors","securityGroups":[{"oauth2":["payment.processor:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5933"}},"schemaId":"schema_5933"}],"pointer":"/paths/~1payment-processors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5933","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5933"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-processors/peach.payment_processors.handlers.get_payment_processors"}],"panels":[]}]},"httpPath":"/payment-processors"},{"label":"Create payment processor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.create_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.create_payment_processor","metadata":{"seo":{"title":"Create payment processor","description":"Create payment processor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_processors.handlers.create_payment_processor","name":"Create payment processor","isWebhook":false,"pointer":"/paths/~1payment-processors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment processor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.processor:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skipConnectionTest","in":"query","schemaId":"schema_5623","description":"Skip SFTP connection test. This is not recommended - use only after consulting with Peach."}],"pointer":"/paths/~1payment-processors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentProcessorCreateRequest"}},"schemaId":"components/schemas/PaymentProcessorCreateRequest","pointer":"/paths/~1payment-processors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-processors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"skipConnectionTest","in":"query","required":false,"schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.processor:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentProcessorCreateRequest"}},"responseCodes":["200"],"pointer":"/payment-processors","href":"payment-processors/peach.payment_processors.handlers.create_payment_processor","openApiOperationId":"peach.payment_processors.handlers.create_payment_processor","summary":"Create payment processor","securityGroups":[{"oauth2":["payment.processor:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PaymentProcessorCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentProcessorCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}},"schemaId":"schema_5934"}],"pointer":"/paths/~1payment-processors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5934","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-processors/peach.payment_processors.handlers.create_payment_processor"}],"panels":[]}]},"httpPath":"/payment-processors"},{"label":"Delete payment processor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.delete_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.delete_payment_processor","metadata":{"seo":{"title":"Delete payment processor","description":"Delete payment processor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_processors.handlers.delete_payment_processor","name":"Delete payment processor","isWebhook":false,"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete payment processor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.processor:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payment-processors/{paymentProcessorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.processor:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/payment-processors/{paymentProcessorId}","href":"payment-processors/peach.payment_processors.handlers.delete_payment_processor","openApiOperationId":"peach.payment_processors.handlers.delete_payment_processor","summary":"Delete payment processor","securityGroups":[{"oauth2":["payment.processor:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted"}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-processors/peach.payment_processors.handlers.delete_payment_processor"}],"panels":[]}]},"httpPath":"/payment-processors/{paymentProcessorId}"},{"label":"Get payment processor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_one_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_one_payment_processor","metadata":{"seo":{"title":"Get payment processor","description":"Get payment processor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_processors.handlers.get_one_payment_processor","name":"Get payment processor","isWebhook":false,"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment processor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.processor:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-processors/{paymentProcessorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.processor:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-processors/{paymentProcessorId}","href":"payment-processors/peach.payment_processors.handlers.get_one_payment_processor","openApiOperationId":"peach.payment_processors.handlers.get_one_payment_processor","summary":"Get payment processor","securityGroups":[{"oauth2":["payment.processor:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}},"schemaId":"schema_5934"}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5934","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-processors/peach.payment_processors.handlers.get_one_payment_processor"}],"panels":[]}]},"httpPath":"/payment-processors/{paymentProcessorId}"},{"label":"Update payment processor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.update_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.update_payment_processor","metadata":{"seo":{"title":"Update payment processor","description":"Update payment processor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_processors.handlers.update_payment_processor","name":"Update payment processor","isWebhook":false,"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payment processor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["payment.processor:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentProcessorUpdateRequest"}},"schemaId":"components/schemas/PaymentProcessorUpdateRequest","pointer":"/paths/~1payment-processors~1{paymentProcessorId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payment-processors/{paymentProcessorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["payment.processor:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentProcessorUpdateRequest"}},"responseCodes":["200"],"pointer":"/payment-processors/{paymentProcessorId}","href":"payment-processors/peach.payment_processors.handlers.update_payment_processor","openApiOperationId":"peach.payment_processors.handlers.update_payment_processor","summary":"Update payment processor","securityGroups":[{"oauth2":["payment.processor:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/PaymentProcessorUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentProcessorUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}},"schemaId":"schema_5934"}],"pointer":"/paths/~1payment-processors~1{paymentProcessorId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5934","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5934"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-processors/peach.payment_processors.handlers.update_payment_processor"}],"panels":[]}]},"httpPath":"/payment-processors/{paymentProcessorId}"}],"content":{"contentType":"group","meta":{"name":"Payment Processors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Processors","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach allows clients to bring their own/partner bank to process ACH payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If configured, the Peach system will create NACHA files and upload them to the provided destination (SFTP)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach system will download NACHA return files from the same destination. Make sure you coordinate this setup with the Peach team."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NACHA requires bank accounts to be verified. If you are using Peach system to process ACH payments, borrowers have two options to verify their bank account:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect their online bank account via Plaid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger micro-deposits and verify amounts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the following logic of how Peach system selects payment processor for micro-deposits. A payment method is associated with a borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object instead of a specific loan because the same method can be used to pay multiple loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have only one loan type and one payment processor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment processor to initiate micro-deposits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have more than one loan type and one payment processor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment processor to initiate micro-deposits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have have more than one loan type and more than one payment processor:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can associate a specific payment processor with a loan type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a borrower has one or more loans in status ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] of ONE loan type only,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will use that loan type's ACH payment processor for micro-deposits. If the loan type doesn't have an ACH payment processor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated, the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processor to initiate micro-deposits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a borrower has one or more loans in status ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] of more than one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan type, the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processor to initiate micro-deposits."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-processors","summary":"Get payment processors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-processors/peach.payment_processors.handlers.get_payment_processors","deprecated":false},{"title":"/payment-processors","summary":"Create payment processor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-processors/peach.payment_processors.handlers.create_payment_processor","deprecated":false},{"title":"/payment-processors/{paymentProcessorId}","summary":"Delete payment processor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-processors/peach.payment_processors.handlers.delete_payment_processor","deprecated":false},{"title":"/payment-processors/{paymentProcessorId}","summary":"Get payment processor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-processors/peach.payment_processors.handlers.get_one_payment_processor","deprecated":false},{"title":"/payment-processors/{paymentProcessorId}","summary":"Update payment processor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-processors/peach.payment_processors.handlers.update_payment_processor","deprecated":false}]}]}]}]}},{"type":"group","label":"Card Issuers","link":"/api-docs/api-public/card-issuers","routeSlug":"/api-docs/api-public/card-issuers","items":[{"label":"Get card issuers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuers_list","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuers_list","metadata":{"seo":{"title":"Get card issuers","description":"Get card issuers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_issuers_list","name":"Get card issuers","isWebhook":false,"pointer":"/paths/~1card-issuers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card issuers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card.issuer:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1card-issuers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/card-issuers","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card.issuer:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/card-issuers","href":"card-issuers/peach.card_issuers.handlers.card_issuers_list","openApiOperationId":"peach.card_issuers.handlers.card_issuers_list","summary":"Get card issuers","securityGroups":[{"oauth2":["card.issuer:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5935"}},"schemaId":"schema_5935"}],"pointer":"/paths/~1card-issuers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5935","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5935"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-issuers/peach.card_issuers.handlers.card_issuers_list"}],"panels":[]}]},"httpPath":"/card-issuers"},{"label":"Create card issuer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_create","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_create","metadata":{"seo":{"title":"Create card issuer","description":"Creates a new card issuer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_issuer_create","name":"Create card issuer","isWebhook":false,"pointer":"/paths/~1card-issuers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create card issuer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new card issuer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card.issuer:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5936"}},"schemaId":"schema_5936","pointer":"/paths/~1card-issuers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/card-issuers","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card.issuer:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5936"}},"responseCodes":["200"],"pointer":"/card-issuers","href":"card-issuers/peach.card_issuers.handlers.card_issuer_create","openApiOperationId":"peach.card_issuers.handlers.card_issuer_create","summary":"Create card issuer","securityGroups":[{"oauth2":["card.issuer:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5936","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5936"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}},"schemaId":"schema_5937"}],"pointer":"/paths/~1card-issuers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5937","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-issuers/peach.card_issuers.handlers.card_issuer_create"}],"panels":[]}]},"httpPath":"/card-issuers"},{"label":"Delete card issuer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_delete","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_delete","metadata":{"seo":{"title":"Delete card issuer","description":"Delete card issuer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_issuer_delete","name":"Delete card issuer","isWebhook":false,"pointer":"/paths/~1card-issuers~1{cardIssuerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete card issuer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card.issuer:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cardIssuerId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the card issuer","required":true}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/card-issuers/{cardIssuerId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"cardIssuerId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card.issuer:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/card-issuers/{cardIssuerId}","href":"card-issuers/peach.card_issuers.handlers.card_issuer_delete","openApiOperationId":"peach.card_issuers.handlers.card_issuer_delete","summary":"Delete card issuer","securityGroups":[{"oauth2":["card.issuer:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-issuers/peach.card_issuers.handlers.card_issuer_delete"}],"panels":[]}]},"httpPath":"/card-issuers/{cardIssuerId}"},{"label":"Get card issuer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_get","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_get","metadata":{"seo":{"title":"Get card issuer by ID","description":"Get card issuer by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_issuer_get","name":"Get card issuer by ID","isWebhook":false,"pointer":"/paths/~1card-issuers~1{cardIssuerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card issuer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card.issuer:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cardIssuerId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the card issuer","required":true}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/card-issuers/{cardIssuerId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"cardIssuerId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card.issuer:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/card-issuers/{cardIssuerId}","href":"card-issuers/peach.card_issuers.handlers.card_issuer_get","openApiOperationId":"peach.card_issuers.handlers.card_issuer_get","summary":"Get card issuer by ID","securityGroups":[{"oauth2":["card.issuer:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}},"schemaId":"schema_5937"}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5937","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-issuers/peach.card_issuers.handlers.card_issuer_get"}],"panels":[]}]},"httpPath":"/card-issuers/{cardIssuerId}"},{"label":"Update card issuer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_update","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_update","metadata":{"seo":{"title":"Update card issuer","description":"Update card issuer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.card_issuers.handlers.card_issuer_update","name":"Update card issuer","isWebhook":false,"pointer":"/paths/~1card-issuers~1{cardIssuerId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update card issuer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["card.issuer:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cardIssuerId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the card issuer","required":true}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardIssuerPut"}},"schemaId":"components/schemas/CardIssuerPut","pointer":"/paths/~1card-issuers~1{cardIssuerId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/card-issuers/{cardIssuerId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"cardIssuerId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["card.issuer:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardIssuerPut"}},"responseCodes":["200"],"pointer":"/card-issuers/{cardIssuerId}","href":"card-issuers/peach.card_issuers.handlers.card_issuer_update","openApiOperationId":"peach.card_issuers.handlers.card_issuer_update","summary":"Update card issuer","securityGroups":[{"oauth2":["card.issuer:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CardIssuerPut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardIssuerPut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}},"schemaId":"schema_5937"}],"pointer":"/paths/~1card-issuers~1{cardIssuerId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5937","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5937"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-issuers/peach.card_issuers.handlers.card_issuer_update"}],"panels":[]}]},"httpPath":"/card-issuers/{cardIssuerId}"}],"content":{"contentType":"group","meta":{"name":"Card Issuers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Issuers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BETA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows clients to manage configurations for card issuers."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/card-issuers","summary":"Get card issuers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-issuers/peach.card_issuers.handlers.card_issuers_list","deprecated":false},{"title":"/card-issuers","summary":"Create card issuer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-issuers/peach.card_issuers.handlers.card_issuer_create","deprecated":false},{"title":"/card-issuers/{cardIssuerId}","summary":"Delete card issuer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/card-issuers/peach.card_issuers.handlers.card_issuer_delete","deprecated":false},{"title":"/card-issuers/{cardIssuerId}","summary":"Get card issuer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-issuers/peach.card_issuers.handlers.card_issuer_get","deprecated":false},{"title":"/card-issuers/{cardIssuerId}","summary":"Update card issuer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/card-issuers/peach.card_issuers.handlers.card_issuer_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Funding Instruments","link":"/api-docs/api-public/funding-instruments","routeSlug":"/api-docs/api-public/funding-instruments","items":[{"label":"Get funding instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","metadata":{"seo":{"title":"Get funding instruments","description":"Get funding instruments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.funding_instrument_get_all","name":"Get funding instruments","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get funding instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["funding.instrument:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["funding.instrument:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","href":"funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","openApiOperationId":"peach.payment_instruments.handlers.funding_instrument_get_all","summary":"Get funding instruments","securityGroups":[{"oauth2":["funding.instrument:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Funding Instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5938"}},"schemaId":"schema_5938"}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5938","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5938"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all"}],"panels":[]}]},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments"},{"label":"Create funding instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","metadata":{"seo":{"title":"Create funding instrument","description":"Create funding instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.funding_instrument_create","name":"Create funding instrument","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create funding instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["funding.instrument:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundingInstrument"}},"schemaId":"components/schemas/FundingInstrument","pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["funding.instrument:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FundingInstrument"}},"responseCodes":["201"],"pointer":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","href":"funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","openApiOperationId":"peach.payment_instruments.handlers.funding_instrument_create","summary":"Create funding instrument","securityGroups":[{"oauth2":["funding.instrument:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/FundingInstrument","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundingInstrument"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Funding Instrument Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5939"}},"schemaId":"schema_5939"}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5939","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5939"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments"},{"label":"Get funding instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","metadata":{"seo":{"title":"Get funding instrument by ID","description":"Get funding instrument by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.funding_instrument_get","name":"Get funding instrument by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get funding instrument by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["funding.instrument:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true},{"name":"fundingInstrumentId","in":"path","schemaId":"schema_5625","description":"Unique funding instrument identifier. Normally a bank account.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"fundingInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["funding.instrument:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","href":"funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","openApiOperationId":"peach.payment_instruments.handlers.funding_instrument_get","summary":"Get funding instrument by ID","securityGroups":[{"oauth2":["funding.instrument:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment Instrument","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5939"}},"schemaId":"schema_5939"}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5939","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5939"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}"},{"label":"Update funding instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","metadata":{"seo":{"title":"Update funding instrument","description":"Update funding instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.funding_instrument_update","name":"Update funding instrument","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update funding instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["funding.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"paymentProcessorId","in":"path","schemaId":"schema_5625","description":"The payment processor ID.","required":true},{"name":"fundingInstrumentId","in":"path","schemaId":"schema_5625","description":"Unique funding instrument identifier. Normally a bank account.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"schemaId":"components/schemas/SettlementInstrumentMutable","pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"paymentProcessorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"fundingInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["funding.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","href":"funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","openApiOperationId":"peach.payment_instruments.handlers.funding_instrument_update","summary":"Update funding instrument","securityGroups":[{"oauth2":["funding.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/SettlementInstrumentMutable","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Funding Instrument Updated"}],"pointer":"/paths/~1companies~1{companyId}~1payment-processors~1{paymentProcessorId}~1funding-instruments~1{fundingInstrumentId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}"}],"content":{"contentType":"group","meta":{"name":"Funding Instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Funding Instruments","showPageActions":true},{"nodeType":"markdoc","content":"This object represents a bank account belonging to a payment processor. Peach uses the funding\ninstrument's available balance (sourced from BAI files) to wire investor settlement payments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","summary":"Get funding instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","deprecated":false},{"title":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","summary":"Create funding instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","deprecated":false},{"title":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","summary":"Get funding instrument by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","deprecated":false},{"title":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","summary":"Update funding instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Organization Management","content":null},{"type":"group","label":"Employees","link":"/api-docs/api-public/employees","routeSlug":"/api-docs/api-public/employees","items":[{"label":"Get employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employees_get","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employees_get","metadata":{"seo":{"title":"Get employees","description":"Get employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employees_get","name":"Get employees","isWebhook":false,"pointer":"/paths/~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get employees\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"teamId","in":"query","schemaId":"schema_5625","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"** DEPRECATED - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teamIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ** Filter results to a single team."},"children":[]}]}]}]},{"name":"teamIds","in":"query","schemaId":"schema_5694","description":"Filter results to employees that belong to at least one of a list of teams."},{"name":"excludeTeamIds","in":"query","schemaId":"schema_5694","description":"Filter results to employees that do not belong to any of a list of teams."},{"name":"managerEmployeeId","in":"query","schemaId":"schema_5625","description":"The employee ID of the manager"},{"name":"search","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search term on which to search. It will match ANY employee when the search term matches the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case-insensitive matches any substring of an employee's first name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case-insensitive matches any substring of an employee's last name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if there is whitespace in the search term, split on the whitespace, and case-insensitive match the first part to any substring of an employee's first name and the second part to any substring of the last name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly matches an employee's user's ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly matches an employee's ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly matches an employee's external ID (prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly matches one of employee's role IDs"},"children":[]}]}]}]}]}],"pointer":"/paths/~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"teamId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"teamIds","in":"query","schemaId":"schema_5694"},{"name":"excludeTeamIds","in":"query","schemaId":"schema_5694"},{"name":"managerEmployeeId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"search","in":"query","required":false,"schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/employees","href":"employees/peach.employees.handlers.employees.employees_get","openApiOperationId":"peach.employees.handlers.employees.employees_get","summary":"Get employees","securityGroups":[{"oauth2":["employee:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5940"}},"schemaId":"schema_5940"}],"pointer":"/paths/~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5940","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5940"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employees_get"}],"panels":[]}]},"httpPath":"/employees"},{"label":"Create employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_create","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_create","metadata":{"seo":{"title":"Create employee","description":"Create a new employee for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employee_create","name":"Create employee","isWebhook":false,"pointer":"/paths/~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new employee for a company.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5941"}},"schemaId":"schema_5941","pointer":"/paths/~1employees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employees","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5941"}},"responseCodes":["200"],"pointer":"/employees","href":"employees/peach.employees.handlers.employees.employee_create","openApiOperationId":"peach.employees.handlers.employees.employee_create","summary":"Create employee","securityGroups":[{"oauth2":["employee:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5941","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5941"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}},"schemaId":"schema_5942"}],"pointer":"/paths/~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5942","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employee_create"}],"panels":[]}]},"httpPath":"/employees"},{"label":"Get employee by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_get_by_id","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_get_by_id","metadata":{"seo":{"title":"Get employee by ID","description":"Get employee by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employee_get_by_id","name":"Get employee by ID","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get employee by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get employee by ID\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employees/{employeeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/employees/{employeeId}","href":"employees/peach.employees.handlers.employees.employee_get_by_id","openApiOperationId":"peach.employees.handlers.employees.employee_get_by_id","summary":"Get employee by ID","securityGroups":[{"oauth2":["employee:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}},"schemaId":"schema_5942"}],"pointer":"/paths/~1employees~1{employeeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5942","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employee_get_by_id"}],"panels":[]}]},"httpPath":"/employees/{employeeId}"},{"label":"Update employee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_update","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_update","metadata":{"seo":{"title":"Update employee","description":"Update an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employee_update","name":"Update employee","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an employee\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee","pointer":"/paths/~1employees~1{employeeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employees/{employeeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Employee"}},"responseCodes":["200"],"pointer":"/employees/{employeeId}","href":"employees/peach.employees.handlers.employees.employee_update","openApiOperationId":"peach.employees.handlers.employees.employee_update","summary":"Update employee","securityGroups":[{"oauth2":["employee:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Employee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}},"schemaId":"schema_5942"}],"pointer":"/paths/~1employees~1{employeeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5942","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5942"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employee_update"}],"panels":[]}]},"httpPath":"/employees/{employeeId}"},{"label":"Get email signature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_get","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_get","metadata":{"seo":{"title":"Get email signature","description":"Get the employee's email signature"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.email_signature.employee_email_signature_get","name":"Get email signature","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}~1email-signature/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get email signature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the employee's email signature\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee.emailsignature:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}~1email-signature/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employees/{employeeId}/email-signature","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee.emailsignature:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/employees/{employeeId}/email-signature","href":"employees/peach.employees.handlers.email_signature.employee_email_signature_get","openApiOperationId":"peach.employees.handlers.email_signature.employee_email_signature_get","summary":"Get email signature","securityGroups":[{"oauth2":["employee.emailsignature:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5943"}},"schemaId":"schema_5943"}],"pointer":"/paths/~1employees~1{employeeId}~1email-signature/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5943","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5943"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.email_signature.employee_email_signature_get"}],"panels":[]}]},"httpPath":"/employees/{employeeId}/email-signature"},{"label":"Update email signature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_set","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_set","metadata":{"seo":{"title":"Update email signature","description":"Update the employee's email signature"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.email_signature.employee_email_signature_set","name":"Update email signature","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}~1email-signature/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update email signature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the employee's email signature\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee.emailsignature:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}~1email-signature/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailSignatureUpdate"}},"schemaId":"components/schemas/EmailSignatureUpdate","pointer":"/paths/~1employees~1{employeeId}~1email-signature/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employees/{employeeId}/email-signature","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee.emailsignature:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailSignatureUpdate"}},"responseCodes":["200"],"pointer":"/employees/{employeeId}/email-signature","href":"employees/peach.employees.handlers.email_signature.employee_email_signature_set","openApiOperationId":"peach.employees.handlers.email_signature.employee_email_signature_set","summary":"Update email signature","securityGroups":[{"oauth2":["employee.emailsignature:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/EmailSignatureUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailSignatureUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5943"}},"schemaId":"schema_5943"}],"pointer":"/paths/~1employees~1{employeeId}~1email-signature/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5943","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5943"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.email_signature.employee_email_signature_set"}],"panels":[]}]},"httpPath":"/employees/{employeeId}/email-signature"},{"label":"Remove employee from team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_remove_from_team","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_remove_from_team","metadata":{"seo":{"title":"Remove employee from team","description":"Remove an employee from a team"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employee_remove_from_team","name":"Remove employee from team","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove employee from team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove an employee from a team\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true},{"name":"teamId","in":"path","schemaId":"schema_5625","description":"The unique team identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employees/{employeeId}/teams/{teamId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"teamId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/employees/{employeeId}/teams/{teamId}","href":"employees/peach.employees.handlers.employees.employee_remove_from_team","openApiOperationId":"peach.employees.handlers.employees.employee_remove_from_team","summary":"Remove employee from team","securityGroups":[{"oauth2":["employee:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employee_remove_from_team"}],"panels":[]}]},"httpPath":"/employees/{employeeId}/teams/{teamId}"},{"label":"Add employee to team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_add_to_team","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_add_to_team","metadata":{"seo":{"title":"Add employee to team","description":"Add employee to a team"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.employees.employee_add_to_team","name":"Add employee to team","isWebhook":false,"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add employee to team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add employee to a team\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["employee:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employeeId","in":"path","schemaId":"schema_5625","description":"The unique employee identifier.","required":true},{"name":"teamId","in":"path","schemaId":"schema_5625","description":"The unique team identifier.","required":true}],"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employees/{employeeId}/teams/{teamId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"employeeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"teamId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["employee:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/employees/{employeeId}/teams/{teamId}","href":"employees/peach.employees.handlers.employees.employee_add_to_team","openApiOperationId":"peach.employees.handlers.employees.employee_add_to_team","summary":"Add employee to team","securityGroups":[{"oauth2":["employee:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1employees~1{employeeId}~1teams~1{teamId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/peach.employees.handlers.employees.employee_add_to_team"}],"panels":[]}]},"httpPath":"/employees/{employeeId}/teams/{teamId}"}],"content":{"contentType":"group","meta":{"name":"Employees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employees","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employees","summary":"Get employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employees_get","deprecated":false},{"title":"/employees","summary":"Create employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employee_create","deprecated":false},{"title":"/employees/{employeeId}","summary":"Get employee by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employee_get_by_id","deprecated":false},{"title":"/employees/{employeeId}","summary":"Update employee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employee_update","deprecated":false},{"title":"/employees/{employeeId}/email-signature","summary":"Get email signature","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/peach.employees.handlers.email_signature.employee_email_signature_get","deprecated":false},{"title":"/employees/{employeeId}/email-signature","summary":"Update email signature","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employees/peach.employees.handlers.email_signature.employee_email_signature_set","deprecated":false},{"title":"/employees/{employeeId}/teams/{teamId}","summary":"Remove employee from team","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employee_remove_from_team","deprecated":false},{"title":"/employees/{employeeId}/teams/{teamId}","summary":"Add employee to team","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employees/peach.employees.handlers.employees.employee_add_to_team","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/api-docs/api-public/teams","routeSlug":"/api-docs/api-public/teams","items":[{"label":"Get teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_get","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_get","metadata":{"seo":{"title":"Get teams","description":"Get all teams in a company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.teams.teams_get","name":"Get teams","isWebhook":false,"pointer":"/paths/~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all teams in a company\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["team:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"offset","in":"query","schemaId":"schema_5629","description":"Offset from the start of results."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"offset","in":"query","required":false,"schemaId":"schema_5629"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["team:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/teams","href":"teams/peach.employees.handlers.teams.teams_get","openApiOperationId":"peach.employees.handlers.teams.teams_get","summary":"Get teams","securityGroups":[{"oauth2":["team:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5944"}},"schemaId":"schema_5944"}],"pointer":"/paths/~1teams/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5944","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5944"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/peach.employees.handlers.teams.teams_get"}],"panels":[]}]},"httpPath":"/teams"},{"label":"Create team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_create","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_create","metadata":{"seo":{"title":"Create team","description":"Create a new team"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.teams.teams_create","name":"Create team","isWebhook":false,"pointer":"/paths/~1teams/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new team\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["team:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Team"}},"schemaId":"components/schemas/Team","pointer":"/paths/~1teams/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/teams","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["team:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Team"}},"responseCodes":["200"],"pointer":"/teams","href":"teams/peach.employees.handlers.teams.teams_create","openApiOperationId":"peach.employees.handlers.teams.teams_create","summary":"Create team","securityGroups":[{"oauth2":["team:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Team","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Team"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}},"schemaId":"schema_5945"}],"pointer":"/paths/~1teams/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5945","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/peach.employees.handlers.teams.teams_create"}],"panels":[]}]},"httpPath":"/teams"},{"label":"Delete team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_delete","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_delete","metadata":{"seo":{"title":"Delete team","description":"Delete team"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.teams.team_delete","name":"Delete team","isWebhook":false,"pointer":"/paths/~1teams~1{teamId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete team\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["team:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_5625","description":"The unique team identifier.","required":true}],"pointer":"/paths/~1teams~1{teamId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/teams/{teamId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["team:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/teams/{teamId}","href":"teams/peach.employees.handlers.teams.team_delete","openApiOperationId":"peach.employees.handlers.teams.team_delete","summary":"Delete team","securityGroups":[{"oauth2":["team:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1teams~1{teamId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/peach.employees.handlers.teams.team_delete"}],"panels":[]}]},"httpPath":"/teams/{teamId}"},{"label":"Get team by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_get","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_get","metadata":{"seo":{"title":"Get team by ID","description":"Get team by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.teams.team_get","name":"Get team by ID","isWebhook":false,"pointer":"/paths/~1teams~1{teamId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get team by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get team by ID\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["team:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_5625","description":"The unique team identifier.","required":true}],"pointer":"/paths/~1teams~1{teamId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams/{teamId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["team:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/teams/{teamId}","href":"teams/peach.employees.handlers.teams.team_get","openApiOperationId":"peach.employees.handlers.teams.team_get","summary":"Get team by ID","securityGroups":[{"oauth2":["team:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}},"schemaId":"schema_5945"}],"pointer":"/paths/~1teams~1{teamId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5945","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/peach.employees.handlers.teams.team_get"}],"panels":[]}]},"httpPath":"/teams/{teamId}"},{"label":"Update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_update","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_update","metadata":{"seo":{"title":"Update","description":"Update team"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.employees.handlers.teams.team_update","name":"Update","isWebhook":false,"pointer":"/paths/~1teams~1{teamId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update team\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["team:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_5625","description":"The unique team identifier.","required":true}],"pointer":"/paths/~1teams~1{teamId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Team"}},"schemaId":"components/schemas/Team","pointer":"/paths/~1teams~1{teamId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/teams/{teamId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["team:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Team"}},"responseCodes":["200"],"pointer":"/teams/{teamId}","href":"teams/peach.employees.handlers.teams.team_update","openApiOperationId":"peach.employees.handlers.teams.team_update","summary":"Update","securityGroups":[{"oauth2":["team:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Team","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Team"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}},"schemaId":"schema_5945"}],"pointer":"/paths/~1teams~1{teamId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5945","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5945"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/peach.employees.handlers.teams.team_update"}],"panels":[]}]},"httpPath":"/teams/{teamId}"}],"content":{"contentType":"group","meta":{"name":"Teams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/teams","summary":"Get teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/peach.employees.handlers.teams.teams_get","deprecated":false},{"title":"/teams","summary":"Create team","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams/peach.employees.handlers.teams.teams_create","deprecated":false},{"title":"/teams/{teamId}","summary":"Delete team","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/teams/peach.employees.handlers.teams.team_delete","deprecated":false},{"title":"/teams/{teamId}","summary":"Get team by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/peach.employees.handlers.teams.team_get","deprecated":false},{"title":"/teams/{teamId}","summary":"Update","prefix":{"name":"put","color":"put"},"badges":[],"link":"/teams/peach.employees.handlers.teams.team_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/api-docs/api-public/users","routeSlug":"/api-docs/api-public/users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.users_get","routeSlug":"/api-docs/api-public/users/peach.users.handlers.users_get","metadata":{"seo":{"title":"Get users","description":"Get users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.users.handlers.users_get","name":"Get users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"userType","in":"query","schemaId":"schema_5618","description":"User type."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"userType","in":"query","schemaId":"components/schemas/UserType"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/users","href":"users/peach.users.handlers.users_get","openApiOperationId":"peach.users.handlers.users_get","summary":"Get users","securityGroups":[{"oauth2":["user:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersPaging"}},"schemaId":"components/schemas/UsersPaging"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsersPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/peach.users.handlers.users_get"}],"panels":[]}]},"httpPath":"/users"},{"label":"Create user\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_create","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_create","metadata":{"seo":{"title":"Create user\n","description":"Creates a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.users.handlers.user_create","name":"Create user\n","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType.phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required depending on company configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType.password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required unless the company is configured to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTimeCodeEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTimeCodeText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in which case sends an empty string."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"schemaId":"components/schemas/UserCreate","pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"responseCodes":["201"],"pointer":"/users","href":"users/peach.users.handlers.user_create","openApiOperationId":"peach.users.handlers.user_create","summary":"Create user\n","securityGroups":[{"oauth2":["user:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/UserCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}},"schemaId":"schema_5946"}],"pointer":"/paths/~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5946","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/peach.users.handlers.user_create"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_get","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_get","metadata":{"seo":{"title":"Get user","description":"Get user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.users.handlers.user_get","name":"Get user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/users/{userId}","href":"users/peach.users.handlers.user_get","openApiOperationId":"peach.users.handlers.user_get","summary":"Get user","securityGroups":[{"oauth2":["user:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}},"schemaId":"schema_5946"}],"pointer":"/paths/~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5946","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/peach.users.handlers.user_get"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_update","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_update","metadata":{"seo":{"title":"Update user","description":"Update user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.users.handlers.user_update","name":"Update user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"schemaId":"components/schemas/UserUpdate","pointer":"/paths/~1users~1{userId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"responseCodes":["200"],"pointer":"/users/{userId}","href":"users/peach.users.handlers.user_update","openApiOperationId":"peach.users.handlers.user_update","summary":"Update user","securityGroups":[{"oauth2":["user:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/UserUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}},"schemaId":"schema_5946"}],"pointer":"/paths/~1users~1{userId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5946","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5946"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/peach.users.handlers.user_update"}],"panels":[]}]},"httpPath":"/users/{userId}"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Get users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/peach.users.handlers.users_get","deprecated":false},{"title":"/users","summary":"Create user\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/peach.users.handlers.user_create","deprecated":false},{"title":"/users/{userId}","summary":"Get user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/peach.users.handlers.user_get","deprecated":false},{"title":"/users/{userId}","summary":"Update user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/peach.users.handlers.user_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/api-docs/api-public/roles","routeSlug":"/api-docs/api-public/roles","items":[{"label":"Get user's current permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.users.handlers.user_get_permissions","routeSlug":"/api-docs/api-public/roles/peach.users.handlers.user_get_permissions","metadata":{"seo":{"title":"Get user's current permissions","description":"Given"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.users.handlers.user_get_permissions","name":"Get user's current permissions","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user's current permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Given\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["user:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}~1permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}/permissions","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["user:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/users/{userId}/permissions","href":"roles/peach.users.handlers.user_get_permissions","openApiOperationId":"peach.users.handlers.user_get_permissions","summary":"Get user's current permissions","securityGroups":[{"oauth2":["user:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1users~1{userId}~1permissions/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/peach.users.handlers.user_get_permissions"}],"panels":[]}]},"httpPath":"/users/{userId}/permissions"},{"label":"Get user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_get","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_get","metadata":{"seo":{"title":"Get user roles","description":"Get user roles"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.roles.handlers.user_role_get","name":"Get user roles","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["role:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1users~1{userId}~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}/roles","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["role:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/users/{userId}/roles","href":"roles/peach.roles.handlers.user_role_get","openApiOperationId":"peach.roles.handlers.user_role_get","summary":"Get user roles","securityGroups":[{"oauth2":["role:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleCollection"}},"schemaId":"components/schemas/RoleCollection"}],"pointer":"/paths/~1users~1{userId}~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/peach.roles.handlers.user_role_get"}],"panels":[]}]},"httpPath":"/users/{userId}/roles"},{"label":"Remove role from user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_delete","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_delete","metadata":{"seo":{"title":"Remove role from user","description":"Remove role from user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.roles.handlers.user_role_delete","name":"Remove role from user","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove role from user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["role:unassign"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique role identifier.","required":true},{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{userId}/roles/{roleId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["role:unassign"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/users/{userId}/roles/{roleId}","href":"roles/peach.roles.handlers.user_role_delete","openApiOperationId":"peach.roles.handlers.user_role_delete","summary":"Remove role from user","securityGroups":[{"oauth2":["role:unassign"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/peach.roles.handlers.user_role_delete"}],"panels":[]}]},"httpPath":"/users/{userId}/roles/{roleId}"},{"label":"Add role to user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_update","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_update","metadata":{"seo":{"title":"Add role to user","description":"Add role to user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.roles.handlers.user_role_update","name":"Add role to user","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add role to user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["role:assign"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"components/schemas/newStatus","description":"Unique role identifier.","required":true},{"name":"userId","in":"path","schemaId":"schema_5625","description":"Unique user identifier.","required":true}],"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}/roles/{roleId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["role:assign"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/users/{userId}/roles/{roleId}","href":"roles/peach.roles.handlers.user_role_update","openApiOperationId":"peach.roles.handlers.user_role_update","summary":"Add role to user","securityGroups":[{"oauth2":["role:assign"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1users~1{userId}~1roles~1{roleId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/peach.roles.handlers.user_role_update"}],"panels":[]}]},"httpPath":"/users/{userId}/roles/{roleId}"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{userId}/permissions","summary":"Get user's current permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/peach.users.handlers.user_get_permissions","deprecated":false},{"title":"/users/{userId}/roles","summary":"Get user roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/peach.roles.handlers.user_role_get","deprecated":false},{"title":"/users/{userId}/roles/{roleId}","summary":"Remove role from user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/roles/peach.roles.handlers.user_role_delete","deprecated":false},{"title":"/users/{userId}/roles/{roleId}","summary":"Add role to user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/roles/peach.roles.handlers.user_role_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Capital Markets Management","content":null},{"type":"group","label":"Investors","link":"/api-docs/api-public/investors","routeSlug":"/api-docs/api-public/investors","items":[{"label":"Get investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get_all","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get_all","metadata":{"seo":{"title":"Get investors","description":"Get all investors under the given company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.investor_get_all","name":"Get investors","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get investors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all investors under the given company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["investor:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/investors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["investor:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/investors","href":"investors/peach.payment_instruments.handlers.investor_get_all","openApiOperationId":"peach.payment_instruments.handlers.investor_get_all","summary":"Get investors","securityGroups":[{"oauth2":["investor:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5947"}},"schemaId":"schema_5947"}],"pointer":"/paths/~1companies~1{companyId}~1investors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5947","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5947"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/investors/peach.payment_instruments.handlers.investor_get_all"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors"},{"label":"Create investor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_create","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_create","metadata":{"seo":{"title":"Create investor","description":"Create an investor under the umbrella of the given company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.investor_create","name":"Create investor","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create investor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an investor under the umbrella of the given company.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["investor:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1companies~1{companyId}~1investors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Investor"}},"schemaId":"components/schemas/Investor","pointer":"/paths/~1companies~1{companyId}~1investors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/investors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["investor:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Investor"}},"responseCodes":["201"],"pointer":"/companies/{companyId}/investors","href":"investors/peach.payment_instruments.handlers.investor_create","openApiOperationId":"peach.payment_instruments.handlers.investor_create","summary":"Create investor","securityGroups":[{"oauth2":["investor:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Investor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Investor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Investor"}},"schemaId":"components/schemas/Investor"}],"pointer":"/paths/~1companies~1{companyId}~1investors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Investor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Investor"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/investors/peach.payment_instruments.handlers.investor_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors"},{"label":"Get investor by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get","metadata":{"seo":{"title":"Get investor by ID","description":"Get investor by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.investor_get","name":"Get investor by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get investor by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["investor:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/investors/{investorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["investor:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/investors/{investorId}","href":"investors/peach.payment_instruments.handlers.investor_get","openApiOperationId":"peach.payment_instruments.handlers.investor_get","summary":"Get investor by ID","securityGroups":[{"oauth2":["investor:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Investor"}},"schemaId":"components/schemas/Investor"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Investor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Investor"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/investors/peach.payment_instruments.handlers.investor_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}"},{"label":"Update investor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_update","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_update","metadata":{"seo":{"title":"Update investor","description":"Update investor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.investor_update","name":"Update investor","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update investor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["investor:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate","in":"query","schemaId":"schema_5644","description":"Validate the contact through an external API. This is only used for addresses currently."}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvestorMutable"}},"schemaId":"components/schemas/InvestorMutable","pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/investors/{investorId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"validate","in":"query","required":false,"schemaId":"schema_5644"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["investor:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvestorMutable"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/investors/{investorId}","href":"investors/peach.payment_instruments.handlers.investor_update","openApiOperationId":"peach.payment_instruments.handlers.investor_update","summary":"Update investor","securityGroups":[{"oauth2":["investor:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/InvestorMutable","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvestorMutable"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"updated"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/investors/peach.payment_instruments.handlers.investor_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}"},{"label":"Get loan investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.people.loans.handlers.internal_loan_investors_get_all","routeSlug":"/api-docs/api-public/investors/peach.people.loans.handlers.internal_loan_investors_get_all","metadata":{"seo":{"title":"Get loan investors","description":"Get loan investors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.people.loans.handlers.internal_loan_investors_get_all","name":"Get loan investors","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1loans~1{loanId}~1investors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan investors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"personId","in":"path","schemaId":"schema_5625","description":"A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n","required":true},{"name":"loanId","in":"path","schemaId":"schema_5625","description":"The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n","required":true}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1loans~1{loanId}~1investors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/people/{personId}/loans/{loanId}/investors","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"personId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"loanId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/people/{personId}/loans/{loanId}/investors","href":"investors/peach.people.loans.handlers.internal_loan_investors_get_all","openApiOperationId":"peach.people.loans.handlers.internal_loan_investors_get_all","summary":"Get loan investors","securityGroups":[{"oauth2":["loan:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanInvestorsPaging"}},"schemaId":"components/schemas/LoanInvestorsPaging"}],"pointer":"/paths/~1companies~1{companyId}~1people~1{personId}~1loans~1{loanId}~1investors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LoanInvestorsPaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoanInvestorsPaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/investors/peach.people.loans.handlers.internal_loan_investors_get_all"}],"panels":[]}]},"httpPath":"/companies/{companyId}/people/{personId}/loans/{loanId}/investors"}],"content":{"contentType":"group","meta":{"name":"Investors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Investors","showPageActions":true},{"nodeType":"markdoc","content":"This object represents institutional owners of loans. Investors must be created before they\ncan be associated with loans."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/investors","summary":"Get investors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/investors/peach.payment_instruments.handlers.investor_get_all","deprecated":false},{"title":"/companies/{companyId}/investors","summary":"Create investor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/investors/peach.payment_instruments.handlers.investor_create","deprecated":false},{"title":"/companies/{companyId}/investors/{investorId}","summary":"Get investor by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/investors/peach.payment_instruments.handlers.investor_get","deprecated":false},{"title":"/companies/{companyId}/investors/{investorId}","summary":"Update investor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/investors/peach.payment_instruments.handlers.investor_update","deprecated":false},{"title":"/companies/{companyId}/people/{personId}/loans/{loanId}/investors","summary":"Get loan investors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/investors/peach.people.loans.handlers.internal_loan_investors_get_all","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlement Instruments","link":"/api-docs/api-public/settlement-instruments","routeSlug":"/api-docs/api-public/settlement-instruments","items":[{"label":"Get settlement instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","metadata":{"seo":{"title":"Get settlement instruments","description":"Returns all settlement instruments registered for an investor. These are the bank accounts the Peach payment processor will wire investor settlement proceeds to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.settlement_instrument_get_all","name":"Get settlement instruments","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get settlement instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all settlement instruments registered for an investor. These are the bank accounts\nthe Peach payment processor will wire investor settlement proceeds to.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["settlement.instrument:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/investors/{investorId}/settlement-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["settlement.instrument:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/investors/{investorId}/settlement-instruments","href":"settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","openApiOperationId":"peach.payment_instruments.handlers.settlement_instrument_get_all","summary":"Get settlement instruments","securityGroups":[{"oauth2":["settlement.instrument:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Settlement Instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5948"}},"schemaId":"schema_5948"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5948","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5948"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments"},{"label":"Create settlement instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","metadata":{"seo":{"title":"Create settlement instrument","description":"Registers a bank account as a settlement instrument for an investor. The Peach payment processor will use this account to wire the investor's share of collected borrower payments as part of automated daily investor settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.settlement_instrument_create","name":"Create settlement instrument","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create settlement instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Registers a bank account as a settlement instrument for an investor. The Peach payment\nprocessor will use this account to wire the investor's share of collected borrower payments\nas part of automated daily investor settlement.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["settlement.instrument:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrument"}},"schemaId":"components/schemas/SettlementInstrument","pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/investors/{investorId}/settlement-instruments","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["settlement.instrument:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettlementInstrument"}},"responseCodes":["201"],"pointer":"/companies/{companyId}/investors/{investorId}/settlement-instruments","href":"settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","openApiOperationId":"peach.payment_instruments.handlers.settlement_instrument_create","summary":"Create settlement instrument","securityGroups":[{"oauth2":["settlement.instrument:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/SettlementInstrument","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrument"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Settlement Instrument Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5949"}},"schemaId":"schema_5949"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5949","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5949"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments"},{"label":"Get settlement instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","metadata":{"seo":{"title":"Get settlement instrument by ID","description":"Get settlement instrument by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.settlement_instrument_get","name":"Get settlement instrument by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get settlement instrument by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["settlement.instrument:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true},{"name":"settlementInstrumentId","in":"path","schemaId":"schema_5625","description":"Unique settlement instrument identifier. Normally a bank account.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"settlementInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["settlement.instrument:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","href":"settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","openApiOperationId":"peach.payment_instruments.handlers.settlement_instrument_get","summary":"Get settlement instrument by ID","securityGroups":[{"oauth2":["settlement.instrument:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment Instrument","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5949"}},"schemaId":"schema_5949"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5949","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5949"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}"},{"label":"Update settlement instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","metadata":{"seo":{"title":"Update settlement instrument","description":"Update settlement instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.payment_instruments.handlers.settlement_instrument_update","name":"Update settlement instrument","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update settlement instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["settlement.instrument:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"investorId","in":"path","schemaId":"schema_5625","description":"Unique investor identifier.","required":true},{"name":"settlementInstrumentId","in":"path","schemaId":"schema_5625","description":"Unique settlement instrument identifier. Normally a bank account.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"schemaId":"components/schemas/SettlementInstrumentMutable","pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"investorId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"settlementInstrumentId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["settlement.instrument:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"responseCodes":["204"],"pointer":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","href":"settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","openApiOperationId":"peach.payment_instruments.handlers.settlement_instrument_update","summary":"Update settlement instrument","securityGroups":[{"oauth2":["settlement.instrument:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/SettlementInstrumentMutable","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettlementInstrumentMutable"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Settlement Instrument Updated"}],"pointer":"/paths/~1companies~1{companyId}~1investors~1{investorId}~1settlement-instruments~1{settlementInstrumentId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}"}],"content":{"contentType":"group","meta":{"name":"Settlement Instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlement Instruments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A settlement instrument is a bank account belonging to a loan investor. The Peach payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processor uses these accounts to wire settlement proceeds to investors after collecting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement instruments are only relevant for companies using the Peach-managed payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processor ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isSettlementRequired: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Companies using a third-party payment processor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handle investor settlement outside of Peach and do not use these endpoints."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/investors/{investorId}/settlement-instruments","summary":"Get settlement instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","deprecated":false},{"title":"/companies/{companyId}/investors/{investorId}/settlement-instruments","summary":"Create settlement instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","deprecated":false},{"title":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","summary":"Get settlement instrument by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","deprecated":false},{"title":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","summary":"Update settlement instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Loan Tape Types","link":"/api-docs/api-public/loan-tape-types","routeSlug":"/api-docs/api-public/loan-tape-types","items":[{"label":"Get loan tape types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","metadata":{"seo":{"title":"Get loan tape types","description":"Get loan tape types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_types_list","name":"Get loan tape types","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan tape types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.type:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-tape-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.type:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tape-types","href":"loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","openApiOperationId":"peach.loans.tape.handlers.loan_tape_types_list","summary":"Get loan tape types","securityGroups":[{"oauth2":["loan.tape.type:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5950"}},"schemaId":"schema_5950"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5950","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5950"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tape-types"},{"label":"Create loan tape type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","metadata":{"seo":{"title":"Create loan tape type","description":"Creates a new loan tape type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_type_create","name":"Create loan tape type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create loan tape type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new loan tape type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.type:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5951"}},"schemaId":"schema_5951","pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/loan-tape-types","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.type:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5951"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tape-types","href":"loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","openApiOperationId":"peach.loans.tape.handlers.loan_tape_type_create","summary":"Create loan tape type","securityGroups":[{"oauth2":["loan.tape.type:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5951","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5951"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}},"schemaId":"schema_5952"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5952","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tape-types"},{"label":"Delete loan tape type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","metadata":{"seo":{"title":"Delete loan tape type","description":"Delete loan tape type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_type_delete","name":"Delete loan tape type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete loan tape type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape type","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","href":"loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","openApiOperationId":"peach.loans.tape.handlers.loan_tape_type_delete","summary":"Delete loan tape type","securityGroups":[{"oauth2":["loan.tape.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}"},{"label":"Get loan tape type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","metadata":{"seo":{"title":"Get loan tape type by ID","description":"Get loan tape type by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_type_get","name":"Get loan tape type by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan tape type by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.type:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape type","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.type:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","href":"loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","openApiOperationId":"peach.loans.tape.handlers.loan_tape_type_get","summary":"Get loan tape type by ID","securityGroups":[{"oauth2":["loan.tape.type:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}},"schemaId":"schema_5952"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5952","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}"},{"label":"Update loan tape type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","metadata":{"seo":{"title":"Update loan tape type","description":"Update loan tape type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_type_update","name":"Update loan tape type","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan tape type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.type:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeTypeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape type","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaseLoanTapeType"}},"schemaId":"components/schemas/BaseLoanTapeType","pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeTypeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.type:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BaseLoanTapeType"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","href":"loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","openApiOperationId":"peach.loans.tape.handlers.loan_tape_type_update","summary":"Update loan tape type","securityGroups":[{"oauth2":["loan.tape.type:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/BaseLoanTapeType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaseLoanTapeType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}},"schemaId":"schema_5952"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tape-types~1{loanTapeTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5952","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5952"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}"}],"content":{"contentType":"group","meta":{"name":"Loan Tape Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Tape Types","showPageActions":true},{"nodeType":"markdoc","content":"Allows configuration for which fields should be included for loans or payments tapes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/loan-tape-types","summary":"Get loan tape types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","deprecated":false},{"title":"/companies/{companyId}/loan-tape-types","summary":"Create loan tape type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","deprecated":false},{"title":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","summary":"Delete loan tape type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","deprecated":false},{"title":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","summary":"Get loan tape type by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","deprecated":false},{"title":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","summary":"Update loan tape type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Loan Tapes","link":"/api-docs/api-public/loan-tapes","routeSlug":"/api-docs/api-public/loan-tapes","items":[{"label":"Get loan tapes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_list","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_list","metadata":{"seo":{"title":"Get loan tapes","description":"Get loan tapes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tapes_list","name":"Get loan tapes","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan tapes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"untokenize","in":"query","schemaId":"schema_5623","description":"Untokenize any tokenized fields if the calling user has the applicable permission."},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-tapes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"untokenize","in":"query","schemaId":"schema_5623"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tapes","href":"loan-tapes/peach.loans.tape.handlers.loan_tapes_list","openApiOperationId":"peach.loans.tape.handlers.loan_tapes_list","summary":"Get loan tapes","securityGroups":[{"oauth2":["loan.tape:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5953"}},"schemaId":"schema_5953"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5953","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5953"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tapes_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes"},{"label":"Create loan tape","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_create","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_create","metadata":{"seo":{"title":"Create loan tape","description":"Creates a new loan tape."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_create","name":"Create loan tape","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create loan tape","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new loan tape."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5954"}},"schemaId":"schema_5954","pointer":"/paths/~1companies~1{companyId}~1loan-tapes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/loan-tapes","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5954"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tapes","href":"loan-tapes/peach.loans.tape.handlers.loan_tape_create","openApiOperationId":"peach.loans.tape.handlers.loan_tape_create","summary":"Create loan tape","securityGroups":[{"oauth2":["loan.tape:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5954","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5954"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}},"schemaId":"schema_5955"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5955","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tape_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes"},{"label":"Generate Loan Tapes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","metadata":{"seo":{"title":"Generate Loan Tapes","description":"Generate Loan Tapes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tapes_generate","name":"Generate Loan Tapes","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Loan Tapes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:generate"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5956"}},"schemaId":"schema_5956","pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1generate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/loan-tapes/generate","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:generate"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5956"}},"responseCodes":["201"],"pointer":"/companies/{companyId}/loan-tapes/generate","href":"loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","openApiOperationId":"peach.loans.tape.handlers.loan_tapes_generate","summary":"Generate Loan Tapes","securityGroups":[{"oauth2":["loan.tape:generate"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5956","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5956"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5957"}},"schemaId":"schema_5957"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_5957","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5957"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes/generate"},{"label":"Delete loan tape","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_delete","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_delete","metadata":{"seo":{"title":"Delete loan tape","description":"Delete loan tape"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_delete","name":"Delete loan tape","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete loan tape","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/loan-tapes/{loanTapeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/loan-tapes/{loanTapeId}","href":"loan-tapes/peach.loans.tape.handlers.loan_tape_delete","openApiOperationId":"peach.loans.tape.handlers.loan_tape_delete","summary":"Delete loan tape","securityGroups":[{"oauth2":["loan.tape:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tape_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}"},{"label":"Get loan tape by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_get","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_get","metadata":{"seo":{"title":"Get loan tape by ID","description":"Get loan tape by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_get","name":"Get loan tape by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan tape by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"untokenize","in":"query","schemaId":"schema_5623","description":"Untokenize any tokenized fields if the calling user has the applicable permission."}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-tapes/{loanTapeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"untokenize","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tapes/{loanTapeId}","href":"loan-tapes/peach.loans.tape.handlers.loan_tape_get","openApiOperationId":"peach.loans.tape.handlers.loan_tape_get","summary":"Get loan tape by ID","securityGroups":[{"oauth2":["loan.tape:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}},"schemaId":"schema_5955"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5955","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tape_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}"},{"label":"Update loan tape","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_update","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_update","metadata":{"seo":{"title":"Update loan tape","description":"Update loan tape"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_update","name":"Update loan tape","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update loan tape","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanTape"}},"schemaId":"components/schemas/LoanTape","pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/loan-tapes/{loanTapeId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LoanTape"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tapes/{loanTapeId}","href":"loan-tapes/peach.loans.tape.handlers.loan_tape_update","openApiOperationId":"peach.loans.tape.handlers.loan_tape_update","summary":"Update loan tape","securityGroups":[{"oauth2":["loan.tape:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/LoanTape","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoanTape"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}},"schemaId":"schema_5955"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5955","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5955"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tape_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}"},{"label":"Get loan tape records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","metadata":{"seo":{"title":"Get loan tape records","description":"Records are sorted by createdAt descending"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.tape.handlers.loan_tape_records_list","name":"Get loan tape records","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}~1records/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loan tape records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" descending"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan.tape.record:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"loanTapeId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the loan tape","required":true}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}~1records/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/loan-tapes/{loanTapeId}/records","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"loanTapeId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan.tape.record:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/loan-tapes/{loanTapeId}/records","href":"loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","openApiOperationId":"peach.loans.tape.handlers.loan_tape_records_list","summary":"Get loan tape records","securityGroups":[{"oauth2":["loan.tape.record:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5958"}},"schemaId":"schema_5958"}],"pointer":"/paths/~1companies~1{companyId}~1loan-tapes~1{loanTapeId}~1records/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5958","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5958"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}/records"}],"content":{"contentType":"group","meta":{"name":"Loan Tapes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Tapes","showPageActions":true},{"nodeType":"markdoc","content":"Allows investors to get different loan tapes delivered to different SFTP servers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/loan-tapes","summary":"Get loan tapes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tapes_list","deprecated":false},{"title":"/companies/{companyId}/loan-tapes","summary":"Create loan tape","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tape_create","deprecated":false},{"title":"/companies/{companyId}/loan-tapes/generate","summary":"Generate Loan Tapes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","deprecated":false},{"title":"/companies/{companyId}/loan-tapes/{loanTapeId}","summary":"Delete loan tape","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tape_delete","deprecated":false},{"title":"/companies/{companyId}/loan-tapes/{loanTapeId}","summary":"Get loan tape by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tape_get","deprecated":false},{"title":"/companies/{companyId}/loan-tapes/{loanTapeId}","summary":"Update loan tape","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tape_update","deprecated":false},{"title":"/companies/{companyId}/loan-tapes/{loanTapeId}/records","summary":"Get loan tape records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","deprecated":false}]}]}]}]}},{"type":"separator","label":"Merchants Management","content":null},{"type":"group","label":"Merchants","link":"/api-docs/api-public/merchants","routeSlug":"/api-docs/api-public/merchants","items":[{"label":"Get merchants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchants_list","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchants_list","metadata":{"seo":{"title":"Get merchants","description":"Get merchants"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.merchants.handlers.merchants_list","name":"Get merchants","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1merchants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get merchants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["merchant:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1merchants/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parentMerchantId","in":"query","schemaId":"schema_5625","description":"The parent merchant identifier. Used to represent hierarchy of merchant sub entities.\nCan be Peach or lender's external identifier.\n"}],"pointer":"/paths/~1companies~1{companyId}~1merchants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/merchants","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"parentMerchantId","in":"query","required":false,"schemaId":"components/schemas/AnyId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["merchant:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/merchants","href":"merchants/peach.merchants.handlers.merchants_list","openApiOperationId":"peach.merchants.handlers.merchants_list","summary":"Get merchants","securityGroups":[{"oauth2":["merchant:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5959"}},"schemaId":"schema_5959"}],"pointer":"/paths/~1companies~1{companyId}~1merchants/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5959","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5959"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/peach.merchants.handlers.merchants_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/merchants"},{"label":"Create merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_create","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_create","metadata":{"seo":{"title":"Create merchant","description":"Creates a new merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.merchants.handlers.merchant_create","name":"Create merchant","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1merchants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new merchant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["merchant:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1merchants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5960"}},"schemaId":"schema_5960","pointer":"/paths/~1companies~1{companyId}~1merchants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/merchants","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["merchant:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5960"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/merchants","href":"merchants/peach.merchants.handlers.merchant_create","openApiOperationId":"peach.merchants.handlers.merchant_create","summary":"Create merchant","securityGroups":[{"oauth2":["merchant:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5960","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5960"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}},"schemaId":"schema_5961"}],"pointer":"/paths/~1companies~1{companyId}~1merchants/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5961","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/peach.merchants.handlers.merchant_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/merchants"},{"label":"Get merchant by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_get","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_get","metadata":{"seo":{"title":"Get merchant by ID","description":"Get merchant by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.merchants.handlers.merchant_get","name":"Get merchant by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get merchant by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["merchant:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"merchantId","in":"path","schemaId":"schema_5625","description":"A lender's identifier for the merchant.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/merchants/{merchantId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"merchantId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["merchant:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/merchants/{merchantId}","href":"merchants/peach.merchants.handlers.merchant_get","openApiOperationId":"peach.merchants.handlers.merchant_get","summary":"Get merchant by ID","securityGroups":[{"oauth2":["merchant:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}},"schemaId":"schema_5961"}],"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5961","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/peach.merchants.handlers.merchant_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/merchants/{merchantId}"},{"label":"Update merchant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_update","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_update","metadata":{"seo":{"title":"Update merchant","description":"Update merchant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.merchants.handlers.merchant_update","name":"Update merchant","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["merchant:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"merchantId","in":"path","schemaId":"schema_5625","description":"A lender's identifier for the merchant.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchant"}},"schemaId":"components/schemas/Merchant","pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/merchants/{merchantId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"merchantId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["merchant:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Merchant"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/merchants/{merchantId}","href":"merchants/peach.merchants.handlers.merchant_update","openApiOperationId":"peach.merchants.handlers.merchant_update","summary":"Update merchant","securityGroups":[{"oauth2":["merchant:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/Merchant","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchant"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}},"schemaId":"schema_5961"}],"pointer":"/paths/~1companies~1{companyId}~1merchants~1{merchantId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5961","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5961"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/peach.merchants.handlers.merchant_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/merchants/{merchantId}"}],"content":{"contentType":"group","meta":{"name":"Merchants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchants","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows lenders to keep track of merchants associated with loans and purchases."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant details can be shown in the Peach Borrower Portal. The following attributes are shown to a borrower:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" businessName"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPARTMENT OR CONTACT NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" primaryContactName"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" primaryContactEmail"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" primaryContactPhone"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/merchants","summary":"Get merchants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchants/peach.merchants.handlers.merchants_list","deprecated":false},{"title":"/companies/{companyId}/merchants","summary":"Create merchant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchants/peach.merchants.handlers.merchant_create","deprecated":false},{"title":"/companies/{companyId}/merchants/{merchantId}","summary":"Get merchant by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchants/peach.merchants.handlers.merchant_get","deprecated":false},{"title":"/companies/{companyId}/merchants/{merchantId}","summary":"Update merchant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/merchants/peach.merchants.handlers.merchant_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Events and Webhooks Management","content":null},{"type":"group","label":"Events","link":"/api-docs/api-public/events","routeSlug":"/api-docs/api-public/events","items":[{"label":"Retrieve events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/events/peach.events.handlers.get_events","routeSlug":"/api-docs/api-public/events/peach.events.handlers.get_events","metadata":{"seo":{"title":"Retrieve events","description":"Retrieve events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.events.handlers.get_events","name":"Retrieve events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["event:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."},{"name":"sortBy","in":"query","schemaId":"schema_5632","description":"The data attributes by which to sort the results."},{"name":"personId","in":"query","schemaId":"schema_5625","description":"Filter by a Borrower's unique identifier. Can be Peach or lender's external identifier.\n"},{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus","description":"Use this to limit results to a specific periodId."},{"name":"loanId","in":"query","schemaId":"schema_5625","description":"Filter by Loan's unique identifier. Can be Peach or lender's external identifier.\n"},{"name":"caseId","in":"query","schemaId":"schema_5625","description":"Filter by case's object unique identifier. Can be Peach or lender's external identifier.\n"},{"name":"transactionId","in":"query","schemaId":"schema_5625","description":"Filter by transaction's unique identifier. Can be Peach or lender's external identifier.\n"},{"name":"createdAtFrom","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Get events created at or after the specified time."},{"name":"createdAtTo","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Get events created before the specified time."},{"name":"effectiveAtFrom","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Get events effective at or after the specified time."},{"name":"effectiveAtTo","in":"query","schemaId":"components/schemas/transactionCreatedAt","description":"Get events effective before the specified time."},{"name":"accrualDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":"Get events by matching accrual date. To be used for AccrueInterestEvent only."},{"name":"includeDeleted","in":"query","schemaId":"schema_5644","description":"Include events that have been deleted."},{"name":"events","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma separated list of event names to return."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event name queries can end with a wildcard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character to specify all events starting with the given string."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would give all case-related events."},"children":[]}]}]}]},{"name":"excludeEvents","in":"query","schemaId":"components/schemas/newStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma separated list of event names to exclude from the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event name queries can end with a wildcard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character to specify all events starting with the given string."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would exclude all case-related events."},"children":[]}]}]}]},{"name":"webhookId","in":"query","schemaId":"components/schemas/newStatus","description":"The webhook ID to filter events by. This will only include events that were sent to this webhook subscription.\n"},{"name":"supercaseId","in":"query","schemaId":"components/schemas/newStatus","description":"The supercase ID to filter events by. Events that don't have this field will be filtered out.\n"},{"name":"skipTotalCount","in":"query","schemaId":"schema_5623","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Skip computing the exact "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count of matching events to improve performance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as an arbitrary large value and must not be relied upon."},"children":[]}]}]}]},{"name":"creatingMessageIds","in":"query","schemaId":"schema_5632","description":"A comma separated list of creatingMessageIds to return."}],"pointer":"/paths/~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_5632"},{"name":"personId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"periodId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"loanId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"caseId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"transactionId","in":"query","schemaId":"components/schemas/AnyId"},{"name":"createdAtFrom","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"createdAtTo","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"effectiveAtFrom","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"effectiveAtTo","in":"query","schemaId":"components/schemas/transactionCreatedAt"},{"name":"accrualDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"includeDeleted","in":"query","schemaId":"schema_5644"},{"name":"events","in":"query","schemaId":"components/schemas/newStatus"},{"name":"excludeEvents","in":"query","schemaId":"components/schemas/newStatus"},{"name":"webhookId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"supercaseId","in":"query","schemaId":"components/schemas/newStatus"},{"name":"skipTotalCount","in":"query","schemaId":"schema_5623"},{"name":"creatingMessageIds","in":"query","schemaId":"schema_5632"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["event:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/events","href":"events/peach.events.handlers.get_events","openApiOperationId":"peach.events.handlers.get_events","summary":"Retrieve events","securityGroups":[{"oauth2":["event:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5962"}},"schemaId":"schema_5962"}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5962","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5962"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/peach.events.handlers.get_events"}],"panels":[]}]},"httpPath":"/events"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents an event. Events are sent from Peach to you. Events can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"related to any object in this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Object"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"advance.statuschanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an advance status changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"advance.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an advance amount is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autopay.schedule.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an autopay schedule is set up"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autopay.schedule.cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an autopay schedule is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autopay.schedule.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an autopay schedule is changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autopay.payment.rescheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an autopay payment is rescheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autopay.payment.canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an autopay payment is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a card is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card.replacement.requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a card replacement is requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card.status.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a card's status is changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a case is created, updated, or deleted, with precise change information"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no longer fired, use case.changed instead] a case is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - was never used, use case.changed instead] a case is deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no longer fired, use case.changed instead] a case is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.association.added"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an association is added to a case"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.association.removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an association is removed from a case"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.donotinteract.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a DoNotInteract object is created, updated, or deleted, with precise change information"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.donotinteract.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use case.donotinteract.changed instead] a DoNotInteract object is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.donotinteract.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use case.donotinteract.changed instead] a DoNotInteract object is deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.donotinteract.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use case.donotinteract.changed instead] a DoNotInteract object is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.donotinteract.expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a DoNotInteract object has expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.escalation.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a case escalation is created, updated, or deleted, with precise change information"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.escalation.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use case.escalation.changed instead] a case escalation is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case.escalation.canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use case.escalation.changed instead] a case escalation is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a contact is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a contact is deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a contact is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"communication.send"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"communication is attempted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indexrate.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"index rate is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indexrate.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"index rate is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction.blocked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction is blocked for a borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.balance.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan balance changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.closed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is closed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.credit.limit.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan credit limit was changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draw.credit.limit.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a draw credit limit was changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.creditreporting.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is scheduled to start credit reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Reporting Status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.creditreporting.stopped"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is scheduled to stop credit reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Reporting Status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.current"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is current or became current"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.duedate.defer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a single loan due date is deferred"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.fee.booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a dynamic fee is applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.fee.canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a dynamic fee is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.fee.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a dynamic fee is changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.interest.capitalized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest capitalization is triggered after a due date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.interestaccrued.min"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum interest charge is triggered on a draw"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.latefee.booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a late fee is applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.modificationfee.booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a modification fee is applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.migration.succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan migration succeeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.migration.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan migration fails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.obligation.statuschanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a change in a loan's obligation status is recorded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.overdue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is overdue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.overdue.update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan is overdue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.ownerchanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan changes owners"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.paymentplan.setup"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan payment plan is set up"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.period.started"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan period has started"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promiseplan.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promise to pay plan is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promiseplan.statuschanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promise to pay plan status changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promiseplan.due.today"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promise to pay plan is due today"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promiseplan.overdue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promise to pay plan becomes \"overdue\""},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promiseplan.current"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promise to pay plan changes from \"overdue\" to \"current\""},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promise to Pay Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promoprogram.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promo program is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.promoprogram.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a promo program is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.rate.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.rate.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments on a loan are refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.reimbursement.initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a borrower reimbursement is initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.reimbursement.processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a borrower reimbursement is processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.schedule.defer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan schedule is deferred"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.changeloanterms.scra.update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan SCRA plan is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.scraplan.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan SCRA plan is changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.scraplan.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan SCRA plan is deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.servicefee.booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a service fee is booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.membershipfee.booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a membership fee is booked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan.statuschanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a loan changes status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"person.consent.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a borrower updates their consents"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"person.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a borrower is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"person.monitoring.bankruptcy.started"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bankruptcy and deceased monitoring begins for a borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"person.monitoring.scra.started"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRA monitoring begins for a borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.instrument.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment instrument is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.instrument.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment instrument is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.instrument.deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment instrument is deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used in place of payment.initiated for internal ACH prior to deprecation."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.chargeback"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is charged back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.chargeback.reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is chargeback is reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment fails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.rescheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment is rescheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.due.today"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"periodically for external transactions with a status of \"scheduled\""},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment.hold.days.expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a transaction's hold days expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentplan.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment plan is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentplan.statuschanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a payment plan changes status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase is authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase is settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase is applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.dispute.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase dispute is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase Dispute"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase.dispute.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a purchase dispute is updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase Dispute"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statement.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a statement is created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reconciliation.payment.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a reconciliation payment fails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"Retrieve events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/peach.events.handlers.get_events","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/api-docs/api-public/webhooks","routeSlug":"/api-docs/api-public/webhooks","items":[{"label":"Get webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhooks_list","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhooks_list","metadata":{"seo":{"title":"Get webhooks","description":"Get webhooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhooks_list","name":"Get webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/webhooks","href":"webhooks/peach.webhooks.handlers.webhooks_list","openApiOperationId":"peach.webhooks.handlers.webhooks_list","summary":"Get webhooks","securityGroups":[{"oauth2":["webhook.subscription:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5963"}},"schemaId":"schema_5963"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5963","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5963"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhooks_list"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Create webhook subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_create","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_create","metadata":{"seo":{"title":"Create webhook subscription","description":"Creates a new webhook subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhook_create","name":"Create webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new webhook subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5964"}},"schemaId":"schema_5964","pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5964"}},"responseCodes":["200"],"pointer":"/webhooks","href":"webhooks/peach.webhooks.handlers.webhook_create","openApiOperationId":"peach.webhooks.handlers.webhook_create","summary":"Create webhook subscription","securityGroups":[{"oauth2":["webhook.subscription:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5964","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5964"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}},"schemaId":"schema_5965"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5965","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhook_create"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Delete webhook subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_delete","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_delete","metadata":{"seo":{"title":"Delete webhook subscription","description":"Delete webhook subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhook_delete","name":"Delete webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the webhook subscription","required":true}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/webhooks/{webhookSubscriptionId}","href":"webhooks/peach.webhooks.handlers.webhook_delete","openApiOperationId":"peach.webhooks.handlers.webhook_delete","summary":"Delete webhook subscription","securityGroups":[{"oauth2":["webhook.subscription:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhook_delete"}],"panels":[]}]},"httpPath":"/webhooks/{webhookSubscriptionId}"},{"label":"Get webhook subscription by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_get","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_get","metadata":{"seo":{"title":"Get webhook subscription by ID","description":"Get webhook subscription by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhook_get","name":"Get webhook subscription by ID","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook subscription by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the webhook subscription","required":true}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/webhooks/{webhookSubscriptionId}","href":"webhooks/peach.webhooks.handlers.webhook_get","openApiOperationId":"peach.webhooks.handlers.webhook_get","summary":"Get webhook subscription by ID","securityGroups":[{"oauth2":["webhook.subscription:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}},"schemaId":"schema_5965"}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5965","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhook_get"}],"panels":[]}]},"httpPath":"/webhooks/{webhookSubscriptionId}"},{"label":"Update webhook subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_update","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_update","metadata":{"seo":{"title":"Update webhook subscription","description":"Update webhook subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhook_update","name":"Update webhook subscription","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the webhook subscription","required":true}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionPut"}},"schemaId":"components/schemas/WebhookSubscriptionPut","pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionPut"}},"responseCodes":["200"],"pointer":"/webhooks/{webhookSubscriptionId}","href":"webhooks/peach.webhooks.handlers.webhook_update","openApiOperationId":"peach.webhooks.handlers.webhook_update","summary":"Update webhook subscription","securityGroups":[{"oauth2":["webhook.subscription:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/WebhookSubscriptionPut","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionPut"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}},"schemaId":"schema_5965"}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5965","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5965"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhook_update"}],"panels":[]}]},"httpPath":"/webhooks/{webhookSubscriptionId}"},{"label":"Test a webhook with static payload.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_ping","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_ping","metadata":{"seo":{"title":"Test a webhook with static payload.","description":"Test a webhook with static payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.webhooks.handlers.webhook_ping","name":"Test a webhook with static payload.","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}~1ping/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test a webhook with static payload.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["webhook.subscription:ping"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the webhook subscription","required":true}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}~1ping/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks/{webhookSubscriptionId}/ping","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["webhook.subscription:ping"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/webhooks/{webhookSubscriptionId}/ping","href":"webhooks/peach.webhooks.handlers.webhook_ping","openApiOperationId":"peach.webhooks.handlers.webhook_ping","summary":"Test a webhook with static payload.","securityGroups":[{"oauth2":["webhook.subscription:ping"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"}],"pointer":"/paths/~1webhooks~1{webhookSubscriptionId}~1ping/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/peach.webhooks.handlers.webhook_ping"}],"panels":[]}]},"httpPath":"/webhooks/{webhookSubscriptionId}/ping"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows clients to manage webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach webhook system will issue "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests with the event data as JSON payload."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Get webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhooks_list","deprecated":false},{"title":"/webhooks","summary":"Create webhook subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhook_create","deprecated":false},{"title":"/webhooks/{webhookSubscriptionId}","summary":"Delete webhook subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhook_delete","deprecated":false},{"title":"/webhooks/{webhookSubscriptionId}","summary":"Get webhook subscription by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhook_get","deprecated":false},{"title":"/webhooks/{webhookSubscriptionId}","summary":"Update webhook subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhook_update","deprecated":false},{"title":"/webhooks/{webhookSubscriptionId}/ping","summary":"Test a webhook with static payload.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/peach.webhooks.handlers.webhook_ping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Utilities","content":null},{"type":"group","label":"Loan Amortization","link":"/api-docs/api-public/loan-amortization","routeSlug":"/api-docs/api-public/loan-amortization","items":[{"label":"Amortize loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_get","routeSlug":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_get","metadata":{"seo":{"title":"Amortize loan","description":"This utility generates an amortization schedule for an installment loan or line of credit draw.The atOrigination field is where you specify various loan or draw-specific inputs such as thestart date, amount to be financed, and duration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.handlers.amortization_get","name":"Amortize loan","isWebhook":false,"pointer":"/paths/~1amortize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Amortize loan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This utility generates an amortization schedule for an installment loan or line of credit draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is where you specify various loan or draw-specific inputs such as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start date, amount to be financed, and duration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify generic loan type configurations as part of the request body (or omit these"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields and use the default configurations). Alternatively, you can use predefined loan type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configurations by passing in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For a line of credit draw, you can also pass in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in place of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the amortization calculation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will reference the configurations of the loan type associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and will also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the line of credit start date and rates associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if these fields are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not passed in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When generating an amortization schedule from a predefined loan type, you can pass in either a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddressId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the amortization output against any existing rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"caps associated with the loan type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note for the \"Predefined Line Of Credit\" option only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is configured to accrue interest as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accrualMethod=compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a known limitation to the draw amortization calculation logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw amortization calculation will be done using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method and not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure that the system calculates interest accurately, amortized draws should NOT include any fees."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:amortize"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmortizableLoan"}},"schemaId":"components/schemas/AmortizableLoan","pointer":"/paths/~1amortize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/amortize","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:amortize"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AmortizableLoan"}},"responseCodes":["200"],"pointer":"/amortize","href":"loan-amortization/peach.loans.handlers.amortization_get","openApiOperationId":"peach.loans.handlers.amortization_get","summary":"Amortize loan","securityGroups":[{"oauth2":["loan:amortize"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AmortizableLoan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmortizableLoan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5966"}},"schemaId":"schema_5966"}],"pointer":"/paths/~1amortize/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5966","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5966"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-amortization/peach.loans.handlers.amortization_get"}],"panels":[]}]},"httpPath":"/amortize"},{"label":"Amortize loan combinations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_combinations","routeSlug":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_combinations","metadata":{"seo":{"title":"Amortize loan combinations","description":"NOTE: This endpoint does not support recurring dynamic fees. Origination fees and other dynamic non-recurring fees are supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loans.handlers.amortization_combinations","name":"Amortize loan combinations","isWebhook":false,"pointer":"/paths/~1amortize-combinations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Amortize loan combinations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"NOTE: This endpoint does not support recurring dynamic fees. Origination fees and other dynamic non-recurring fees are supported.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["loan:amortize"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmortizeCombinationsBody"}},"schemaId":"components/schemas/AmortizeCombinationsBody","pointer":"/paths/~1amortize-combinations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/amortize-combinations","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["loan:amortize"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AmortizeCombinationsBody"}},"responseCodes":["200"],"pointer":"/amortize-combinations","href":"loan-amortization/peach.loans.handlers.amortization_combinations","openApiOperationId":"peach.loans.handlers.amortization_combinations","summary":"Amortize loan combinations","securityGroups":[{"oauth2":["loan:amortize"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/AmortizeCombinationsBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmortizeCombinationsBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5967"}},"schemaId":"schema_5967"}],"pointer":"/paths/~1amortize-combinations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5967","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5967"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loan-amortization/peach.loans.handlers.amortization_combinations"}],"panels":[]}]},"httpPath":"/amortize-combinations"}],"content":{"contentType":"group","meta":{"name":"Loan Amortization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loan Amortization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/amortize","summary":"Amortize loan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-amortization/peach.loans.handlers.amortization_get","deprecated":false},{"title":"/amortize-combinations","summary":"Amortize loan combinations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loan-amortization/peach.loans.handlers.amortization_combinations","deprecated":false}]}]}]}]}},{"type":"group","label":"Routing Numbers","link":"/api-docs/api-public/routing-numbers","routeSlug":"/api-docs/api-public/routing-numbers","items":[{"label":"Get routing number details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/routing-numbers/peach.routing_numbers.handlers.get_routing_number","routeSlug":"/api-docs/api-public/routing-numbers/peach.routing_numbers.handlers.get_routing_number","metadata":{"seo":{"title":"Get routing number details","description":"Get routing number details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.routing_numbers.handlers.get_routing_number","name":"Get routing number details","isWebhook":false,"pointer":"/paths/~1routing-numbers~1{routingNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get routing number details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["routing.numbers:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routingNumber","in":"path","schemaId":"schema_5968","description":"The routing number. Routing number's length is 9 digits.","required":true}],"pointer":"/paths/~1routing-numbers~1{routingNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/routing-numbers/{routingNumber}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"routingNumber","in":"path","required":true,"schemaId":"schema_5968"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["routing.numbers:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/routing-numbers/{routingNumber}","href":"routing-numbers/peach.routing_numbers.handlers.get_routing_number","openApiOperationId":"peach.routing_numbers.handlers.get_routing_number","summary":"Get routing number details","securityGroups":[{"oauth2":["routing.numbers:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bank Details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5969"}},"schemaId":"schema_5969"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5970"}},"schemaId":"schema_5970"}],"pointer":"/paths/~1routing-numbers~1{routingNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5969","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5969"}}},{"code":"404","schemaId":"schema_5970","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5970"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routing-numbers/peach.routing_numbers.handlers.get_routing_number"}],"panels":[]}]},"httpPath":"/routing-numbers/{routingNumber}"}],"content":{"contentType":"group","meta":{"name":"Routing Numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Routing Numbers","showPageActions":true},{"nodeType":"markdoc","content":"This utility function returns financial institution name that a routing number belongs to.\nThis information is updated once or twice a month by the Federal Reserve Bank."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/routing-numbers/{routingNumber}","summary":"Get routing number details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/routing-numbers/peach.routing_numbers.handlers.get_routing_number","deprecated":false}]}]}]}]}},{"type":"group","label":"BIN Numbers","link":"/api-docs/api-public/bin-numbers","routeSlug":"/api-docs/api-public/bin-numbers","items":[{"label":"Get BIN details from card number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bin-numbers/peach.bin_numbers.handlers.get_bin_number","routeSlug":"/api-docs/api-public/bin-numbers/peach.bin_numbers.handlers.get_bin_number","metadata":{"seo":{"title":"Get BIN details from card number","description":"Get BIN details from card number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.bin_numbers.handlers.get_bin_number","name":"Get BIN details from card number","isWebhook":false,"pointer":"/paths/~1bin-numbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get BIN details from card number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["bin.numbers:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5971"}},"schemaId":"schema_5971","pointer":"/paths/~1bin-numbers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bin-numbers","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["bin.numbers:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5971"}},"responseCodes":["200","404"],"pointer":"/bin-numbers","href":"bin-numbers/peach.bin_numbers.handlers.get_bin_number","openApiOperationId":"peach.bin_numbers.handlers.get_bin_number","summary":"Get BIN details from card number","securityGroups":[{"oauth2":["bin.numbers:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5971","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5971"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card Details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5972"}},"schemaId":"schema_5972"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5973"}},"schemaId":"schema_5973"}],"pointer":"/paths/~1bin-numbers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5972","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5972"}}},{"code":"404","schemaId":"schema_5973","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5973"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bin-numbers/peach.bin_numbers.handlers.get_bin_number"}],"panels":[]}]},"httpPath":"/bin-numbers"}],"content":{"contentType":"group","meta":{"name":"BIN Numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BIN Numbers","showPageActions":true},{"nodeType":"markdoc","content":"This utility function returns card details.\nThe BIN information is provided by First Data and normally updated weekly."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bin-numbers","summary":"Get BIN details from card number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bin-numbers/peach.bin_numbers.handlers.get_bin_number","deprecated":false}]}]}]}]}},{"type":"group","label":"Index Rates","link":"/api-docs/api-public/index-rates","routeSlug":"/api-docs/api-public/index-rates","items":[{"label":"Get index interest rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","metadata":{"seo":{"title":"Get index interest rates","description":"Get index interest rates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loan_configuration.handlers.loan_type_index_rate_get_all","name":"Get index interest rates","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get index interest rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["indexrates:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The from date of the index rate. Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the index rate for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific date."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the index rate. Pass the same value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to get the index rate for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific date. If only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, we assume no end date for the filter."},"children":[]}]}]}]}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loan-types/{loanTypeId}/index-rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[{"name":"fromDate","in":"query","schemaId":"components/schemas/newScheduledDate"},{"name":"toDate","in":"query","schemaId":"components/schemas/newScheduledDate"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["indexrates:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/loan-types/{loanTypeId}/index-rates","href":"index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","openApiOperationId":"peach.loan_configuration.handlers.loan_type_index_rate_get_all","summary":"Get index interest rates","securityGroups":[{"oauth2":["indexrates:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndexRatePaging"}},"schemaId":"components/schemas/IndexRatePaging"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IndexRatePaging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndexRatePaging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/index-rates"},{"label":"Add index interest rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","metadata":{"seo":{"title":"Add index interest rate","description":"Add index interest rate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loan_configuration.handlers.loan_type_index_rate_add","name":"Add index interest rate","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add index interest rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["indexrates:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndexRate"}},"schemaId":"components/schemas/IndexRate","pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/loan-types/{loanTypeId}/index-rates","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["indexrates:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IndexRate"}},"responseCodes":["200"],"pointer":"/loan-types/{loanTypeId}/index-rates","href":"index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","openApiOperationId":"peach.loan_configuration.handlers.loan_type_index_rate_add","summary":"Add index interest rate","securityGroups":[{"oauth2":["indexrates:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/IndexRate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndexRate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}},"schemaId":"schema_5974"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5974","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/index-rates"},{"label":"Cancel index interest rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","metadata":{"seo":{"title":"Cancel index interest rate","description":"Cancel index interest rate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loan_configuration.handlers.loan_type_index_rate_delete","name":"Cancel index interest rate","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel index interest rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["indexrates:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true},{"name":"indexRateId","in":"path","schemaId":"schema_5625","description":"The index rate identifier. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"indexRateId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["indexrates:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","href":"index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","openApiOperationId":"peach.loan_configuration.handlers.loan_type_index_rate_delete","summary":"Cancel index interest rate","securityGroups":[{"oauth2":["indexrates:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}"},{"label":"Get index interest rate by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","metadata":{"seo":{"title":"Get index interest rate by ID","description":"Get index interest rate by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loan_configuration.handlers.loan_type_index_rate_get","name":"Get index interest rate by ID","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get index interest rate by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["indexrates:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true},{"name":"indexRateId","in":"path","schemaId":"schema_5625","description":"The index rate identifier. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"indexRateId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["indexrates:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","href":"index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","openApiOperationId":"peach.loan_configuration.handlers.loan_type_index_rate_get","summary":"Get index interest rate by ID","securityGroups":[{"oauth2":["indexrates:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}},"schemaId":"schema_5974"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5974","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}"},{"label":"Update index interest rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","metadata":{"seo":{"title":"Update index interest rate","description":"This endpoint is used for updating index interest rates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.loan_configuration.handlers.loan_type_index_rate_update","name":"Update index interest rate","isWebhook":false,"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update index interest rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used for updating index interest rates.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["indexrates:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loanTypeId","in":"path","schemaId":"schema_5625","description":"The loan type identifier.","required":true},{"name":"indexRateId","in":"path","schemaId":"schema_5625","description":"The index rate identifier. Can be Peach or lender's external identifier.","required":true}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndexRateUpdate"}},"schemaId":"components/schemas/IndexRateUpdate","pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"loanTypeId","in":"path","required":true,"schemaId":"components/schemas/AnyId"},{"name":"indexRateId","in":"path","required":true,"schemaId":"components/schemas/AnyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["indexrates:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IndexRateUpdate"}},"responseCodes":["200"],"pointer":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","href":"index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","openApiOperationId":"peach.loan_configuration.handlers.loan_type_index_rate_update","summary":"Update index interest rate","securityGroups":[{"oauth2":["indexrates:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/IndexRateUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndexRateUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}},"schemaId":"schema_5974"}],"pointer":"/paths/~1loan-types~1{loanTypeId}~1index-rates~1{indexRateId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5974","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5974"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update"}],"panels":[]}]},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}"}],"content":{"contentType":"group","meta":{"name":"Index Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Index Rates","showPageActions":true},{"nodeType":"markdoc","content":"This utility function is used for managing index interest rates (for example, a rate that is pegged to the prime rate\nof the Fed). Index Interest Rates are set at the loan type level and can be used by loans associated with the loanTypeId.\nIndex Interest Rates are only relevant to interest rates and not relevant to promo rates.\n\nIndex Interest Rate values can be updated with a new value with an effective date in the past. When a new Index Interest\nRate value is set, the previous rate end date will be set to one calendar day before the new rate's effective date.\nIf the new rate's effective date is in the past, the Peach system will replay all Active loans (to clarify, Active loans\nat the time of Index Interest Rate update) with the new Index Interest Rate value and re-accrue loans' interest."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/loan-types/{loanTypeId}/index-rates","summary":"Get index interest rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","deprecated":false},{"title":"/loan-types/{loanTypeId}/index-rates","summary":"Add index interest rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","deprecated":false},{"title":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","summary":"Cancel index interest rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","deprecated":false},{"title":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","summary":"Get index interest rate by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","deprecated":false},{"title":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","summary":"Update index interest rate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations","link":"/api-docs/api-public/operations","routeSlug":"/api-docs/api-public/operations","items":[{"label":"Get operation status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/operations/peach.operation_status.handlers.operation_status_get","routeSlug":"/api-docs/api-public/operations/peach.operation_status.handlers.operation_status_get","metadata":{"seo":{"title":"Get operation status","description":"Get operation status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.operation_status.handlers.operation_status_get","name":"Get operation status","isWebhook":false,"pointer":"/paths/~1operations~1{operationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get operation status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationId","in":"path","schemaId":"schema_5975","description":"Operation ID\n","required":true}],"pointer":"/paths/~1operations~1{operationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/operations/{operationId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"operationId","in":"path","required":true,"schemaId":"schema_5975"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":[]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","206","404","412"],"pointer":"/operations/{operationId}","href":"operations/peach.operation_status.handlers.operation_status_get","openApiOperationId":"peach.operation_status.handlers.operation_status_get","summary":"Get operation status","securityGroups":[{"oauth2":[]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"},{"code":"206","description":"In progress","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"},{"code":"412","description":"Operation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}},"schemaId":"components/schemas/SingletonResponse"}],"pointer":"/paths/~1operations~1{operationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}},{"code":"206","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}},{"code":"404","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}},{"code":"412","schemaId":"components/schemas/SingletonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingletonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/peach.operation_status.handlers.operation_status_get"}],"panels":[]}]},"httpPath":"/operations/{operationId}"}],"content":{"contentType":"group","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations represent ongoing asynchronous tasks in the Peach system. When"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you start an asynchronous task, either directly by having an API call with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or indirectly by having an API call with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out, you will receive an operation ID that can be used to monitor its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an operation completes, the operation ID will continue to be valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for 1 hour, after which it will expire and become inaccessible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Under certain exceptional circumstances, an asychronous task may be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delayed and not complete before 24 hours have passed. At that point, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation ID will expire despite still being in-flight. If this happens,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"please reach out to Peach support."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/operations/{operationId}","summary":"Get operation status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operations/peach.operation_status.handlers.operation_status_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Credit Agencies Management","content":null},{"type":"group","label":"Credit Agencies","link":"/api-docs/api-public/credit-agencies","routeSlug":"/api-docs/api-public/credit-agencies","items":[{"label":"Get credit agencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","metadata":{"seo":{"title":"Get credit agencies","description":"Get credit agencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_agencies_list","name":"Get credit agencies","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get credit agencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.agency:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"uploadedByLender","in":"query","schemaId":"components/schemas/transactionIsExternal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only returns Credit Agency objects that have the SFTP credentials filled in, meaning the lender will upload the file to the credit agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only returns Credit Agency objects that have the SFTP credentials empty, meaning Peach will upload the file to the credit agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not set, includes all."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_5628","description":"The maximum count of results to retrieve."},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus","description":"Return results starting after the provided object identifier."},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus","description":"Return results ending before the provided object identifier."}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/credit-agencies","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"uploadedByLender","in":"query","schemaId":"components/schemas/transactionIsExternal"},{"name":"limit","in":"query","required":false,"schemaId":"schema_5628"},{"name":"startingAfter","in":"query","schemaId":"components/schemas/newStatus"},{"name":"endingBefore","in":"query","schemaId":"components/schemas/newStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.agency:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/credit-agencies","href":"credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","openApiOperationId":"peach.credit_reporting.handlers.credit_agencies_list","summary":"Get credit agencies","securityGroups":[{"oauth2":["credit.agency:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5976"}},"schemaId":"schema_5976"}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5976","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5976"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/credit-agencies"},{"label":"Create credit agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_create","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_create","metadata":{"seo":{"title":"Create credit agency","description":"Creates a new credit agency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_agency_create","name":"Create credit agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create credit agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new credit agency."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.agency:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5977"}},"schemaId":"schema_5977","pointer":"/paths/~1companies~1{companyId}~1credit-agencies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/credit-agencies","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.agency:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5977"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/credit-agencies","href":"credit-agencies/peach.credit_reporting.handlers.credit_agency_create","openApiOperationId":"peach.credit_reporting.handlers.credit_agency_create","summary":"Create credit agency","securityGroups":[{"oauth2":["credit.agency:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5977","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5977"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}},"schemaId":"schema_5978"}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5978","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/credit-agencies"},{"label":"Get credit agency by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_get","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_get","metadata":{"seo":{"title":"Get credit agency by ID","description":"Get credit agency by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_agency_get","name":"Get credit agency by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get credit agency by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.agency:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"creditAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the credit agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/credit-agencies/{creditAgencyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"creditAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.agency:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/credit-agencies/{creditAgencyId}","href":"credit-agencies/peach.credit_reporting.handlers.credit_agency_get","openApiOperationId":"peach.credit_reporting.handlers.credit_agency_get","summary":"Get credit agency by ID","securityGroups":[{"oauth2":["credit.agency:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}},"schemaId":"schema_5978"}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5978","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}"},{"label":"Update credit agency","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_update","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_update","metadata":{"seo":{"title":"Update credit agency","description":"Update credit agency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_agency_update","name":"Update credit agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update credit agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.agency:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"creditAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the credit agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditAgency"}},"schemaId":"components/schemas/CreditAgency","pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/credit-agencies/{creditAgencyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"creditAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.agency:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditAgency"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/credit-agencies/{creditAgencyId}","href":"credit-agencies/peach.credit_reporting.handlers.credit_agency_update","openApiOperationId":"peach.credit_reporting.handlers.credit_agency_update","summary":"Update credit agency","securityGroups":[{"oauth2":["credit.agency:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CreditAgency","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditAgency"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}},"schemaId":"schema_5978"}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5978","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}"},{"label":"Regenerate SSH key pair for credit agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","metadata":{"seo":{"title":"Regenerate SSH key pair for credit agency","description":"Generates a new RSA SSH key pair for the credit agency and returns the updated object.The new sftpSSHPeachPublicKey must be added to the SFTP server's authorized_keys file —the old public key will no longer work after this call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","name":"Regenerate SSH key pair for credit agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}~1regenerate-ssh-keys/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate SSH key pair for credit agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a new RSA SSH key pair for the credit agency and returns the updated object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be added to the SFTP server's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized_keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the old public key will no longer work after this call."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["credit.agency:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"creditAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the credit agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}~1regenerate-ssh-keys/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/credit-agencies/{creditAgencyId}/regenerate-ssh-keys","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"creditAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["credit.agency:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/companies/{companyId}/credit-agencies/{creditAgencyId}/regenerate-ssh-keys","href":"credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","openApiOperationId":"peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","summary":"Regenerate SSH key pair for credit agency","securityGroups":[{"oauth2":["credit.agency:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}},"schemaId":"schema_5978"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1companies~1{companyId}~1credit-agencies~1{creditAgencyId}~1regenerate-ssh-keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5978","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5978"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403"},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys"}],"panels":[]}]},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}/regenerate-ssh-keys"}],"content":{"contentType":"group","meta":{"name":"Credit Agencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Agencies","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/credit-agencies","summary":"Get credit agencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","deprecated":false},{"title":"/companies/{companyId}/credit-agencies","summary":"Create credit agency","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_create","deprecated":false},{"title":"/companies/{companyId}/credit-agencies/{creditAgencyId}","summary":"Get credit agency by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_get","deprecated":false},{"title":"/companies/{companyId}/credit-agencies/{creditAgencyId}","summary":"Update credit agency","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_update","deprecated":false},{"title":"/companies/{companyId}/credit-agencies/{creditAgencyId}/regenerate-ssh-keys","summary":"Regenerate SSH key pair for credit agency","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","deprecated":false}]}]}]}]}},{"type":"separator","label":"Collection Agencies Management","content":null},{"type":"group","label":"Collection Agencies","link":"/api-docs/api-public/collection-agencies","routeSlug":"/api-docs/api-public/collection-agencies","items":[{"label":"Get collection agencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agencies_list","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agencies_list","metadata":{"seo":{"title":"Get collection agencies","description":"Get collection agencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agencies_list","name":"Get collection agencies","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get collection agencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["collection.agency:list"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeArchived","in":"query","schemaId":"schema_5623","description":"If set to true, includes archived objects\n"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/collection-agencies","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[{"name":"includeArchived","in":"query","schemaId":"schema_5623"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["collection.agency:list"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/collection-agencies","href":"collection-agencies/peach.collections.handlers.collection_agencies_list","openApiOperationId":"peach.collections.handlers.collection_agencies_list","summary":"Get collection agencies","securityGroups":[{"oauth2":["collection.agency:list"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5979"}},"schemaId":"schema_5979"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5979","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5979"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-agencies/peach.collections.handlers.collection_agencies_list"}],"panels":[]}]},"httpPath":"/companies/{companyId}/collection-agencies"},{"label":"Create collection agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_create","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_create","metadata":{"seo":{"title":"Create collection agency","description":"Creates a new collection agency. This is useful when a lender assigns a charged off loan to a third party debt collection agency.The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the systemof record / ledger for charged off loans. The lender can post any payments collected by the collection agency as isExternal=true transaction.The Peach system will waterfall the payments and update loan balances."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_create","name":"Create collection agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new collection agency. This is useful when a lender assigns a charged off loan to a third party debt collection agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of record / ledger for charged off loans. The lender can post any payments collected by the collection agency as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach system will waterfall the payments and update loan balances."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["collection.agency:create"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5980"}},"schemaId":"schema_5980","pointer":"/paths/~1companies~1{companyId}~1collection-agencies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{companyId}/collection-agencies","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["collection.agency:create"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5980"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/collection-agencies","href":"collection-agencies/peach.collections.handlers.collection_agency_create","openApiOperationId":"peach.collections.handlers.collection_agency_create","summary":"Create collection agency","securityGroups":[{"oauth2":["collection.agency:create"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"schema_5980","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5980"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}},"schemaId":"schema_5981"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5981","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-agencies/peach.collections.handlers.collection_agency_create"}],"panels":[]}]},"httpPath":"/companies/{companyId}/collection-agencies"},{"label":"Delete collection agency","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_delete","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_delete","metadata":{"seo":{"title":"Delete collection agency","description":"Sets isArchived = true on the agency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_delete","name":"Delete collection agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isArchived = true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the agency"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["collection.agency:delete"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"collectionAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the collection agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"collectionAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["collection.agency:delete"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","href":"collection-agencies/peach.collections.handlers.collection_agency_delete","openApiOperationId":"peach.collections.handlers.collection_agency_delete","summary":"Delete collection agency","securityGroups":[{"oauth2":["collection.agency:delete"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success no content"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-agencies/peach.collections.handlers.collection_agency_delete"}],"panels":[]}]},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}"},{"label":"Get collection agency by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_get","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_get","metadata":{"seo":{"title":"Get collection agency by ID","description":"Get collection agency by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_get","name":"Get collection agency by ID","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get collection agency by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["collection.agency:read"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"collectionAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the collection agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"collectionAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["collection.agency:read"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","href":"collection-agencies/peach.collections.handlers.collection_agency_get","openApiOperationId":"peach.collections.handlers.collection_agency_get","summary":"Get collection agency by ID","securityGroups":[{"oauth2":["collection.agency:read"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}},"schemaId":"schema_5981"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5981","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-agencies/peach.collections.handlers.collection_agency_get"}],"panels":[]}]},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}"},{"label":"Update collection agency","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_update","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_update","metadata":{"seo":{"title":"Update collection agency","description":"Update collection agency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peach.collections.handlers.collection_agency_update","name":"Update collection agency","isWebhook":false,"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update collection agency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["collection.agency:update"],"type":"oauth2","flows":{}}]},{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"apiKeyHeader","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"components/schemas/newStatus","description":"The unique company identifier.","required":true},{"name":"collectionAgencyId","in":"path","schemaId":"components/schemas/newStatus","description":"The ID of the collection agency","required":true}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionAgency"}},"schemaId":"components/schemas/CollectionAgency","pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","servers":[{"url":"https://sandboxapi.peach.finance/api"}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"},{"name":"collectionAgencyId","in":"path","required":true,"schemaId":"components/schemas/newStatus"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{}}],"scopes":["collection.agency:update"]},{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"apiKeyHeader","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionAgency"}},"responseCodes":["200"],"pointer":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","href":"collection-agencies/peach.collections.handlers.collection_agency_update","openApiOperationId":"peach.collections.handlers.collection_agency_update","summary":"Update collection agency","securityGroups":[{"oauth2":["collection.agency:update"]},{"bearerAuth":[]},{"apiKeyHeader":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"schemaId":"components/schemas/CollectionAgency","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionAgency"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}},"schemaId":"schema_5981"}],"pointer":"/paths/~1companies~1{companyId}~1collection-agencies~1{collectionAgencyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_5981","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5981"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-agencies/peach.collections.handlers.collection_agency_update"}],"panels":[]}]},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}"}],"content":{"contentType":"group","meta":{"name":"Collection Agencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Agencies","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows lenders to keep track of different collection agencies that charged-off loans may be assigned to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful when a lender assigns charged off loans to a third party debt collection agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of record / ledger for charged off loans. The lender can post any payments collected by the collection agency as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach system will waterfall the payments and update loan balances."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyId}/collection-agencies","summary":"Get collection agencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-agencies/peach.collections.handlers.collection_agencies_list","deprecated":false},{"title":"/companies/{companyId}/collection-agencies","summary":"Create collection agency","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-agencies/peach.collections.handlers.collection_agency_create","deprecated":false},{"title":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","summary":"Delete collection agency","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collection-agencies/peach.collections.handlers.collection_agency_delete","deprecated":false},{"title":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","summary":"Get collection agency by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-agencies/peach.collections.handlers.collection_agency_get","deprecated":false},{"title":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","summary":"Update collection agency","prefix":{"name":"put","color":"put"},"badges":[],"link":"/collection-agencies/peach.collections.handlers.collection_agency_update","deprecated":false}]}]}]}]}},{"type":"separator","label":"Errors","content":null},{"type":"group","label":"Errors","link":"/api-docs/api-public/errors","routeSlug":"/api-docs/api-public/errors","items":[],"content":{"contentType":"group","meta":{"name":"Errors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Errors","showPageActions":true},{"nodeType":"markdoc","content":"Errors"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/errors"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/Paging":{"id":"components/schemas/Paging","kind":"json-schema","title":"Paging","data":{"description":"Represents a base object for paged results.\n","properties":{"count":{"description":"Total number of items in this result.","readOnly":true,"type":"integer"},"status":{"description":"HTTP status code.","type":"integer"}},"type":"object"}},"components/schemas/CaseEscalation":{"id":"components/schemas/CaseEscalation","kind":"json-schema","title":"Case Escalation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark a case as needing special attention from a particular team or employee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalatedTeamId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalatedEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at one time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalatedTeamId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalatedEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified then the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latest escalation is canceled."},"children":[]}]}]}],"properties":{"escalatedEmployeeId":{"description":"Escalate the case to the employee specified by this employee ID.","nullable":true,"type":"string"},"escalatedTeamId":{"description":"Escalate the case to the team specified by this team ID.","nullable":true,"type":"string"},"isUrgent":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this escalation is urgent and tasks related to this case escalation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should jump to the front of the agents' queues."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"note":{"description":"Create a case note with this content explaining why\nthe escalation or de-escalation took place\n","nullable":true,"type":"string"}},"title":"Case Escalation","type":"object"}},"components/schemas/CaseEscalationDetailed":{"id":"components/schemas/CaseEscalationDetailed","kind":"json-schema","title":"Detailed Case Escalation","data":{"allOf":[{"$ref":"#/components/schemas/CaseEscalation"},{"properties":{"caseId":{"description":"The ID of the escalated case.","type":"string"},"caseName":{"description":"The friendly name given to a case.","nullable":true,"type":"string"},"escalationTargetName":{"description":"The name of the team or employee the escalation was assigned to.","type":"string"}},"type":"object"}],"description":"A Case Escalation with additional details.\n","title":"Detailed Case Escalation"}},"components/schemas/LoanTypeId":{"id":"components/schemas/LoanTypeId","kind":"json-schema","title":"Predefined Loan Type","data":{"properties":{"loanTypeId":{"description":"The loan type identifier. This is created specifically for each lender's loan product by Peach.","type":"string"}},"title":"Predefined Loan Type","type":"object"}},"components/schemas/AddressBase":{"id":"components/schemas/AddressBase","kind":"json-schema","title":"AddressBase","data":{"additionalProperties":false,"description":"The mailing address.\n","properties":{"POBox":{"description":"Post Office Box","nullable":true,"type":"string"},"addressLine1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address line 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company.allowPartialAddress=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then this field is required, else it is not required"},"children":[]}]}]}],"maxLength":100,"type":"string"},"addressLine2":{"description":"Address line 2.","maxLength":100,"nullable":true,"type":"string"},"city":{"description":"City.","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country. English short name according to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"type":"string"},"countyOrRegion":{"description":"County or region.","nullable":true,"type":"string"},"object":{"default":"address","enum":["address"],"readOnly":true,"type":"string"},"postalCode":{"description":"Postal code. Also known as ZIP code.","type":"string"},"state":{"description":"State/Province. This is a required field if the country is US or CA.","maxLength":5,"nullable":true,"type":"string"},"timezone":{"description":"Timezone for the address.","nullable":true,"readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"allOf":[{"$ref":"#/components/schemas/AddressBase"},{"required":["country","postalCode"],"type":"object"}]}},"components/schemas/AdvanceDetails":{"id":"components/schemas/AdvanceDetails","kind":"json-schema","title":"AdvanceDetails","data":{"description":"The details of advance.","nullable":true,"properties":{"categoryId":{"description":"The category identifier of the advance.","nullable":true,"type":"string"},"description":{"default":"Advance","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the advance. Normally shown in Borrower Portal and on statements. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"nullable":true,"type":"string"},"merchantId":{"description":"The merchant identifier that the advance was used for.","nullable":true,"type":"string"},"merchantName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant name that the advance was used for. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"nullable":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"},"pointOfSaleType":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was made online on a website or in a mobile application."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was made in a store with a physical card or instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was made as part of a subscription service."},"children":[]}]}]}]}],"enum":["online","physical","recurring"],"type":"string"}},"type":"object"}},"components/schemas/TimeOfDay":{"id":"components/schemas/TimeOfDay","kind":"json-schema","title":"TimeOfDay","data":{"properties":{"hour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hour. Value range is 0-23. 0=Midnight...23=11 PM."},"children":[]}]}]}],"maximum":23,"minimum":0,"type":"integer"},"minute":{"description":"The minute. Value range is 0-59.","maximum":59,"minimum":0,"type":"integer"},"second":{"default":0,"description":"The second. Value range is 0-59.","maximum":59,"minimum":0,"type":"integer"}},"required":["hour","minute"],"type":"object"}},"components/schemas/externalId":{"id":"components/schemas/externalId","kind":"json-schema","title":"externalId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for a resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the resource is successfully created, a lender can use the Peach assigned ID OR"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifiers to fetch the resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetching with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch a resource using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you MUST use the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a loan with an external identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be referenced like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/people/BO-FAKE-IDNT/loans/ext-ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a resource with an external identifer, you MUST NOT use the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the external identifier should be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ externalId: \"ABCDE\", ... }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"maxLength":200,"nullable":true,"type":"string"}},"components/schemas/Advance":{"id":"components/schemas/Advance","kind":"json-schema","title":"Advance","data":{"properties":{"advanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the advance in the product timezone. The date cannot be in the past or greater than the last due date."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the advance is created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the advance will be recorded in the ledger with an effective timestamp of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Create advance call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the advance is created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the advance will be recorded in the ledger only when the status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"date","type":"string"},"advanceDetails":{"$ref":"#/components/schemas/AdvanceDetails"},"advanceTimeOfDay":{"$ref":"#/components/schemas/TimeOfDay","description":"The time of day that the advance is entered into the ledger in the product timezone."},"amount":{"description":"The amount of advance. The amount must be positive.","format":"float","type":"number"},"canceledBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who canceled the advance."},"children":[]}]}]}],"readOnly":true,"type":"string"},"externalId":{"$ref":"#/components/schemas/externalId","description":"The external unique identifier of the purchase."},"id":{"description":"The unique identifier of the purchase.","readOnly":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","type":"object"},"originalAmount":{"description":"The original amount of the advance. The amount must be positive.","format":"float","readOnly":true,"type":"number"},"status":{"default":"settled","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was scheduled in the future. If the advance status doesn't change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the advance due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date, the system will automatically cancel the advance on the following calendar day (aka change the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: An advance was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for May 27, 2021. On May 28, 2021, the advance status was still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The system will cancel the advance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was settled and/or funded. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" advances increase the loan balance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance is pending. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" advances increases the loan balance similar to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is used mainly for visuals"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and normally shown in Borrower Portal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the advance was canceled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" advances reduce the draw balance. A new advance cannot be created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]}]}],"enum":["scheduled","settled","pending","canceled"],"type":"string"},"timestamps":{"properties":{"canceledAt":{"format":"date-time","readOnly":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"updatedAt":{"format":"date-time","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"title":"Advance","type":"object"}},"components/schemas/AdvanceSchedule":{"id":"components/schemas/AdvanceSchedule","kind":"json-schema","title":"AdvanceSchedule","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The advance schedule of the loan. Total amount of the advances must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"advanceSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will calculate the APR based on the special formula provided in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ecfr.gov/cgi-bin/text-idx?SID=747961e095035658cdddba8b09d30a6f&mc=true&node=pt12.9.1026&rgn=div5#ap12.9.1026.0000_0nbspnbspnbsp.j"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appendix J"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(see examples of loans with multiple advances)."},"children":[]}]}]}],"items":{"allOf":[{"required":["status","amount","advanceDate"],"title":"Advance","type":"object"},{"$ref":"#/components/schemas/Advance"}]},"nullable":true,"type":"array"}},"components/schemas/AmountFinanced":{"id":"components/schemas/AmountFinanced","kind":"json-schema","title":"AmountFinanced","data":{"description":"The amount of principal on origination or draw.","format":"float","type":"number"}},"components/schemas/BufferToPushOutSchedule":{"id":"components/schemas/BufferToPushOutSchedule","kind":"json-schema","title":"BufferToPushOutSchedule","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of calendar days that will be added to the activation date. The resulting date will be used to push out"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due dates as if the loan was activated on that date (activation date + buffer). Interest will still be accrued"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"normally from the activation date. Not valid for the singleTerm frequency."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"components/schemas/OriginationFeeAmount":{"id":"components/schemas/OriginationFeeAmount","kind":"json-schema","title":"OriginationFeeAmount","data":{"default":0,"description":"The origination fee amount.","format":"float","nullable":true,"type":"number"}},"components/schemas/InstallmentPaymentFrequency":{"id":"components/schemas/InstallmentPaymentFrequency","kind":"json-schema","title":"InstallmentPaymentFrequency","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment frequency of the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - are recurring."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a single term loan (aka non-recurring). It will create one period only with a desired \"duration\" of 30, 60, 90, 120, X calendar days or a specific date that should be passed in specificDays. For example [90]."},"children":[]}]}]}],"enum":["weekly","everyTwoWeeks","twiceMonthly","monthly","singleTerm"],"type":"string"}},"components/schemas/PeriodicPaymentAmount":{"id":"components/schemas/PeriodicPaymentAmount","kind":"json-schema","title":"Periodic Payment Amount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amortized periodic payment amount excluding fees. Keep in mind that the last payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"title":"Periodic Payment Amount","type":"number"}},"components/schemas/PrincipalAmount":{"id":"components/schemas/PrincipalAmount","kind":"json-schema","title":"PrincipalAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of principal at origination. Lenders should only pass this value if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is provided, the system will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the loan principal for interest calculations and amortization. The value should be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is not provided, the system will:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount = amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the loan principal for interest calculations and amortization."},"children":[]}]}]}]}],"format":"float","nullable":true,"type":"number"}},"components/schemas/SpecificDays":{"id":"components/schemas/SpecificDays","kind":"json-schema","title":"SpecificDays","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific days designate the day(s) that due dates will fall on. The allowed values for specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day(s) depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-7. 1=Monday...7=Sunday."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide two inputs. The first input (required) is an integer in the valid range 1-7. 1=Monday...7=Sunday."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second input is a date that indicates when to start the cycle. If the second input is not passed, the system will default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the first valid start date based on the first input (the day of week passed in). If this date is provided then it can override"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the minimum due date gap specified on the loan type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1, \"2020-09-16\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide two numbers in the valid range 1-31. 1=first day of a month. Use 31 to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicate the last day of a month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1, 15] or [15, 31]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one or two numbers, depending on the loan type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodCalculationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodCalculationType=dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then provide one number in the valid range 1-31. This is the recurring due date. 1=first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day of a month. Use 31 to indicate the last day of a month. For example: [1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodCalculationType=statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then provide one number in the valid range 1-31. This is the recurring statement date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1=first day of a month. Use 31 to indicate the last day of a month. For example: [1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodCalculationType=fixedStatementAndDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then provide two numbers. First number represents a recurring statement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and the valid range is 1-31. Use 31 to indicate the last day of a month. Second number represents a recurring due date and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the valid range is 1-28. Two numbers must be different. For example: [1, 15] - statements are on 1st and due dates are on 15th."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the due date precedes the statement day, it's pushed to the next month. For example: [20, 10] and today is Oct 1, 2024. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first statement date is Oct 20, 2024 and the first due date is Nov 10th."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For February in non-leap years, if the statement date is ≥ 29 and the due date is 28, the statement date becomes March 1st."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number to indicate duration as a number of calendar days or provide a valid calendar date in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future. This option is only valid for use on the installment type and at loan origination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [90] or [\"2020-09-16\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specificDays is left null, then the system will calculate due dates according to the paymentFrequency relative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the origination or activation date (or use existing specific days in the case of change due date)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specificDays is mandatory."},"children":[]}]}]}],"items":{"anyOf":[{"nullable":true,"type":"string"},{"type":"integer"}]},"nullable":true,"type":"array"}},"components/schemas/GenericInstallmentOriginationPropertiesBase":{"id":"components/schemas/GenericInstallmentOriginationPropertiesBase","kind":"json-schema","title":"GenericInstallmentOriginationPropertiesBase","data":{"properties":{"advanceSchedule":{"$ref":"#/components/schemas/AdvanceSchedule"},"amountFinanced":{"$ref":"#/components/schemas/AmountFinanced"},"bufferToPushOutSchedule":{"$ref":"#/components/schemas/BufferToPushOutSchedule"},"fees":{"properties":{"originationFeeAmount":{"$ref":"#/components/schemas/OriginationFeeAmount"}},"type":"object"},"paymentFrequency":{"$ref":"#/components/schemas/InstallmentPaymentFrequency"},"periodicPaymentAmount":{"$ref":"#/components/schemas/PeriodicPaymentAmount"},"principalAmount":{"$ref":"#/components/schemas/PrincipalAmount"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the loan or line of credit. Passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will set the field to today's date. In the case of the predefined loan type configuration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be converted to the date in the product timezone."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["startDate","amountFinanced","paymentFrequency"],"type":"object"}},"components/schemas/DiscountProgramIds":{"id":"components/schemas/DiscountProgramIds","kind":"json-schema","title":"Discount Program Ids","data":{"properties":{"discountProgramIds":{"description":"The identifiers of the discount programs provided at origination. A discount program\nhas to be created before it can be applied to loans.\n","items":{"type":"integer"},"nullable":true,"type":"array"}},"title":"Discount Program Ids","type":"object"}},"components/schemas/AtOriginationDynamicFees":{"id":"components/schemas/AtOriginationDynamicFees","kind":"json-schema","title":"AtOriginationDynamicFees","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic fees details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable if your loan type has dynamic fee(s) pre-defined and fee(s) amount are different among loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also, for a Line of Credit, this configuration is used to set a dynamic fee type on a selected draw when a dynamic fee type is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appliedToDraws"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawApplicationLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDraws"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the following dynamic fee types are supported: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignTransactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lateFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nsfFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lateFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nsfFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be configured on a single draw."},"children":[]}]}]}],"items":{"properties":{"apiName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of the dynamic fee. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lateFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"breatherFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If applicable, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignTransactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be included, so it is applied to a specific draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please confirm configs with the Peach team to ensure purchase fees are correctly configured."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFeeTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is preferred."},"children":[]}]}]}],"type":"string"},"dynamicFeeTypeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public ID of the dynamic fee type (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FT-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFeeTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is preferred."},"children":[]}]}]}],"type":"string"},"feeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee amount that will be charged recurrently. Only required if the dynamic fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"feeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the dynamic fee that can be charged over the life of the loan or draw. Only required if the dynamic fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"type":"object"},"nullable":true,"type":"array"}},"components/schemas/ServiceFee":{"id":"components/schemas/ServiceFee","kind":"json-schema","title":"Service Fee Origination Terms","data":{"properties":{"fees":{"properties":{"dynamicFees":{"$ref":"#/components/schemas/AtOriginationDynamicFees"},"serviceFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".**"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service fee amount that will be charged recurrently. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".**"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"title":"Service Fee Origination Terms","type":"object"}},"components/schemas/PredefinedInstallmentLoanAtOriginationBase":{"id":"components/schemas/PredefinedInstallmentLoanAtOriginationBase","kind":"json-schema","title":"PredefinedInstallmentLoanAtOriginationBase","data":{"allOf":[{"properties":{"address":{"$ref":"#/components/schemas/Address"},"personAddressId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the existing identifier of a borrower's address contact information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Peach's unique or lender's external identifier). If passed during origination,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the address will be stored on the loan object as a reference. This field, or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mutually exclusive "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field containing an address directly, is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required."},"children":[]}]}]}],"pattern":"^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string","writeOnly":true}},"type":"object"},{"$ref":"#/components/schemas/GenericInstallmentOriginationPropertiesBase"},{"$ref":"#/components/schemas/DiscountProgramIds"},{"$ref":"#/components/schemas/ServiceFee"}]}},"components/schemas/LoanDuration":{"id":"components/schemas/LoanDuration","kind":"json-schema","title":"Duration of a Loan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the loan as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency=monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it's a loan with 6 months duration and will have 6 due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency=weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it's a loan with 24 weeks duration and will have 24 due dates."},"children":[]}]}]}]}],"title":"Duration of a Loan","type":"integer"}},"components/schemas/LoanInterestRatesAtOrigination":{"id":"components/schemas/LoanInterestRatesAtOrigination","kind":"json-schema","title":"LoanInterestRatesAtOrigination","data":{"description":"Interest rates for the loan or the draw. Can be a single interest rate for the entire duration of the loan/draw.\nOr, it can be multiple interest rates for partial periods of the loan/draw. If draw-specific rates are not passed,\nthe draw will use the LOC rates.\n","items":{"properties":{"days":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of calendar days the interest rate applies to. An entry with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"days: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at the end of the list to indicate that the interest rate applies to the end of the loan duration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"days\": 30, \"rate\": 0.1},"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"days\": 60, \"rate\": 0.2},"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"days\": null, \"rate\": 0.25}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan will accrue interest of 10% for the first 30 days. Between days 31-90"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan will accrue interest of 20%. From day 91 until the end, the loan will accrue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest of 25%."},"children":[]}]}]}],"nullable":true,"type":"integer"},"interestType":{"default":"absolute","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest type. The interest type cannot be changed after the loan or draw status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and onward."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use the value as provided here without adding the Index Interest Rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative interest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is outside of the range defined on the loan type, the system will accept the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but will return a warning in the response's object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratesValidation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will calculate an absolute rate by adding the relative loan rate (aka spread)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute to the Index Interest Rate effective on the date the interest is accrued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the Index Interest Rate is not set, the system will assume that the Index Interest Rate value is zero on the date the interest is accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative interest spread "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is allowed, but the system will default to zero if the addition of the Index Interest Rate still results in a negative rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the calculated absolute rate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka spread) plus Index Interest Rate, is outside of the range defined on the loan type, the system will accept the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but will return a warning in the response's object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratesValidation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["absolute","spread"],"type":"string"},"rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest rate for the period defined. The format is decimal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, 0.01 is a 1% annual rate, 0.2 is a 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"}},"required":["days","rate"],"type":"object"},"type":"array"}},"components/schemas/LoanPromoRatesAtOrigination":{"id":"components/schemas/LoanPromoRatesAtOrigination","kind":"json-schema","title":"LoanPromoRatesAtOrigination","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional interest rates (aka rate discounts) for the loan or the draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be a single promo rate for the entire duration of the loan/draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or, it can be multiple promo rates for partial periods of the loan/draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 20% for the first 90 days and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5% for 30 days, then the effective rate for the first 30 days is 15%."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promo rates are unconditional and will be applied regardless of the loan status."},"children":[]}]}]}],"items":{"properties":{"days":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of calendar days the promo rate applies to. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the promo rate applies to the end of the loan duration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"days\": 30 ,\"rate\": 0.1},"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"days\": null, \"rate\": 0.01}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan will receive interest discount of 10% for the first 30 days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From day 31 until the end, the loan will receive interest discount of 1%."},"children":[]}]}]}],"nullable":true,"type":"integer"},"rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual promo rate for the period defined. Loans cannot accrue negative interest rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the promo rate is greater than the interest rate, a loan will accrue 0% interest rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is decimal. For example, 0.01 is a 1% annual rate, 0.15 is a 15% annual rate."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"nullable":true,"type":"array"}},"components/schemas/TotalInterestCapAmount":{"id":"components/schemas/TotalInterestCapAmount","kind":"json-schema","title":"Total Interest Cap Amount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of interest the borrower will ever pay. If not applicable, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"title":"Total Interest Cap Amount","type":"number"}},"components/schemas/GenericInstallmentOriginationPropertiesRates":{"id":"components/schemas/GenericInstallmentOriginationPropertiesRates","kind":"json-schema","title":"GenericInstallmentOriginationPropertiesRates","data":{"properties":{"duration":{"$ref":"#/components/schemas/LoanDuration"},"interestRates":{"$ref":"#/components/schemas/LoanInterestRatesAtOrigination"},"promoRates":{"$ref":"#/components/schemas/LoanPromoRatesAtOrigination"},"totalInterestCapAmount":{"$ref":"#/components/schemas/TotalInterestCapAmount"}},"required":["duration","interestRates"],"type":"object"}},"components/schemas/PredefinedInstallmentLoanAtOrigination":{"id":"components/schemas/PredefinedInstallmentLoanAtOrigination","kind":"json-schema","title":"PredefinedInstallmentLoanAtOrigination","data":{"allOf":[{"$ref":"#/components/schemas/PredefinedInstallmentLoanAtOriginationBase"},{"$ref":"#/components/schemas/GenericInstallmentOriginationPropertiesRates"}]}},"components/schemas/predefinedInstallmentLoanProperties":{"id":"components/schemas/predefinedInstallmentLoanProperties","kind":"json-schema","title":"Predefined Installment Loan","data":{"allOf":[{"$ref":"#/components/schemas/LoanTypeId"},{"properties":{"atOrigination":{"$ref":"#/components/schemas/PredefinedInstallmentLoanAtOrigination"}},"required":["atOrigination","loanTypeId"],"type":"object"}],"title":"Predefined Installment Loan"}},"components/schemas/LoanId":{"id":"components/schemas/LoanId","kind":"json-schema","title":"Loan ID","data":{"properties":{"loanId":{"description":"An identifier of a loan for which to track interactions\n","type":"string"}},"title":"Loan ID","type":"object"}},"components/schemas/LOCPaymentFrequency":{"id":"components/schemas/LOCPaymentFrequency","kind":"json-schema","title":"LOCPaymentFrequency","data":{"description":"The frequency of the due dates schedule. For line of credit, 'weekly' is not allowed.","enum":["everyTwoWeeks","twiceMonthly","monthly"],"type":"string"}},"components/schemas/GenericLOCOriginationProperties":{"id":"components/schemas/GenericLOCOriginationProperties","kind":"json-schema","title":"GenericLOCOriginationProperties","data":{"properties":{"amountFinanced":{"$ref":"#/components/schemas/AmountFinanced"},"bufferToPushOutSchedule":{"$ref":"#/components/schemas/BufferToPushOutSchedule"},"fees":{"properties":{"originationFeeAmount":{"$ref":"#/components/schemas/OriginationFeeAmount"}},"type":"object"},"interestRates":{"$ref":"#/components/schemas/LoanInterestRatesAtOrigination"},"paymentFrequency":{"$ref":"#/components/schemas/LOCPaymentFrequency"},"promoRates":{"$ref":"#/components/schemas/LoanPromoRatesAtOrigination"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the loan or line of credit. Passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will set the field to today's date. In the case of the predefined loan type configuration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be converted to the date in the product timezone."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"}},"components/schemas/PersonAddressId":{"id":"components/schemas/PersonAddressId","kind":"json-schema","title":"Address where a loan was originated.","data":{"properties":{"personAddressId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address where a loan was originated. If an address was already created in Peach's system,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a lender can pass the borrower's contact information identifier. (Peach's unique or lender's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external identifier). Alternatively, the lender can provide address details in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddressAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}],"nullable":true,"pattern":"^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string","writeOnly":true}},"title":"Address where a loan was originated.","type":"object","writeOnly":true}},"components/schemas/DrawProperties":{"id":"components/schemas/DrawProperties","kind":"json-schema","title":"DrawProperties","data":{"properties":{"drawDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the draw as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDatesFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDatesFrequency=monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it's a draw with 6 months duration and will have 6 due dates."},"children":[]}]}]}]}],"type":"integer"},"drawStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw start date. Passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will set the field to today's date. In the case of the predefined loan type configuration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be converted to the date in the product timezone."},"children":[]}]}]}],"format":"date","type":"string"},"fees":{"properties":{"drawFeeAmount":{"default":0,"description":"The draw fee amount.","format":"float","type":"number"}},"type":"object"},"paymentFrequency":{"$ref":"#/components/schemas/LOCPaymentFrequency"}},"type":"object"}},"components/schemas/predefinedLineOfCreditLoanProperties":{"id":"components/schemas/predefinedLineOfCreditLoanProperties","kind":"json-schema","title":"Predefined Line Of Credit","data":{"allOf":[{"$ref":"#/components/schemas/LoanTypeId"},{"$ref":"#/components/schemas/LoanId"},{"properties":{"atOrigination":{"allOf":[{"$ref":"#/components/schemas/GenericLOCOriginationProperties"},{"$ref":"#/components/schemas/PersonAddressId"},{"properties":{"address":{"$ref":"#/components/schemas/Address"}},"type":"object"},{"$ref":"#/components/schemas/DiscountProgramIds"},{"$ref":"#/components/schemas/DrawProperties"},{"$ref":"#/components/schemas/ServiceFee"}],"required":["amountFinanced","drawDuration","drawStartDate"]}},"required":["atOrigination"],"type":"object"}],"title":"Predefined Line Of Credit"}},"components/schemas/AmortUtilPeriodCalculationType":{"id":"components/schemas/AmortUtilPeriodCalculationType","kind":"json-schema","title":"AmortUtilPeriodCalculationType","data":{"properties":{"periodCalculationType":{"default":"dueDate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this configuration allows borrowers to have the same due date every month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, the 15th, 28th, or the last day of every month). In this configuration,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the statement date is calculated as an offset from the dueDate and might be a different day of the month every period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will calculate the first period using the dueDate in reference to the following"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.bufferToPushOutSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The subsequent periods are calculated as recurring due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using the calculated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as an \"anchor\", the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will then be calculated as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"negative \"offset\" from the first due date. The \"offset\" is represented as a number of calendar days based on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locStatementCreationDaysOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this configuration allows borrowers to have the same statement date every month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, the 15th, 28th, or the last day of every month). In this configuration,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the due date might be a different day of the month every period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will calculate the first period using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as an \"anchor\" and take the following attributes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into account: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.bufferToPushOutSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement date can only be a calendar day, and it cannot be forced as a business day. Once the statement date is set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will calculate the first due date based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first due date will be calculated as a positive \"offset\" from the first statement date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateType=business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then we might need to adjust the due date. The \"offset\" is represented as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of calendar days based on the loan type's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locStatementCreationDaysOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following periods are calculated as recurring statement dates (similar to the first period)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applies to line of credit, not installment loans."},"children":[]}]}]}],"enum":["dueDate","statementDate"],"type":"string"}},"type":"object"}},"components/schemas/AccrualMethodWithoutCompoundWithFees":{"id":"components/schemas/AccrualMethodWithoutCompoundWithFees","kind":"json-schema","title":"AccrualMethodWithoutCompoundWithFees","data":{"default":"simple","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"simple"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will accrue interest on outstanding principal buckets/balances only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will accrue interest on outstanding principal and interest buckets/balances."},"children":[]}]}]}],"enum":["simple","compound"],"type":"string"}},"components/schemas/DueDatesGap":{"id":"components/schemas/DueDatesGap","kind":"json-schema","title":"DueDatesGap","data":{"nullable":true,"properties":{"everyTwoWeeks":{"properties":{"max":{"default":21,"type":"integer"},"min":{"default":7,"type":"integer"}},"type":"object"},"monthly":{"properties":{"max":{"default":46,"type":"integer"},"min":{"default":10,"type":"integer"}},"type":"object"},"singleTerm":{"description":"Valid onlyfor installment loans.","properties":{"max":{"default":365,"type":"integer"},"min":{"default":10,"type":"integer"}},"type":"object"},"twiceMonthly":{"properties":{"max":{"default":23,"type":"integer"},"min":{"default":7,"type":"integer"}},"type":"object"},"weekly":{"properties":{"max":{"default":10,"type":"integer"},"min":{"default":4,"type":"integer"}},"type":"object"}},"type":"object"}},"components/schemas/FeeChargeLogic":{"id":"components/schemas/FeeChargeLogic","kind":"json-schema","title":"FeeChargeLogic","data":{"default":"onTopPeriodicPayment","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how to allow the fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onTopPeriodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee will be added on top of the upcoming amortized payment. It means that the upcoming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment will be higher than others."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: first payment amount is $50 periodic payment plus $10 origination fee, total of $60. Second and onward payments' amount is $50."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blendWithPeriodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee will part of the upcoming periodic payment. It means that all expected payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be equal (except for the last one.)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: first payment amount is $50, $10 of which is the origination fee and $40 is amortized payment. Second and onward payments' amount is $50."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee was charged at time of the origination. The fee will not be allocated to future amortized payments."},"children":[]}]}]}],"enum":["onTopPeriodicPayment","blendWithPeriodicPayment","chargedAtOrigination"],"nullable":true,"type":"string"}},"components/schemas/GenericLoanConfigProperties":{"id":"components/schemas/GenericLoanConfigProperties","kind":"json-schema","title":"GenericLoanConfigProperties","data":{"allOf":[{"$ref":"#/components/schemas/AmortUtilPeriodCalculationType"},{"properties":{"accrualMethod":{"$ref":"#/components/schemas/AccrualMethodWithoutCompoundWithFees"},"dailyInterestCalculationMethod":{"default":365,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this loan amortization method assumes that there are 360 days a year and 30 days in each month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The daily interest rates are calculated by taking the annual interest rate and dividing it by 360. This value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be used if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType=fixed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"365"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this loan amortization method assumes that there are 365 days a year and actual number of days between periods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The daily interest rates are calculated by taking the annual interest rate and dividing it by 365."},"children":[]}]}]}],"enum":[360,365],"nullable":true,"type":"integer"},"dueDateAdjustment":{"default":"backward","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a due date falls on non-business date, the due date is moved "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until it falls on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the closest business date. For example, a due date falls on Sunday the 06/16/2019. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateAdjustment=backward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the due date will be adjusted to 06/14/2019. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateAdjustment=forward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the due date will be adjusted to 06/17/2019."},"children":[]}]}]}],"enum":["backward","forward"],"nullable":true,"type":"string"},"dueDateType":{"default":"business","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that due dates must fall on business date only. If a due date falls on non-business date,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the due dates will be adjusted in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" direction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calendar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that due dates can fall on any dates."},"children":[]}]}]}],"enum":["business","calendar"],"nullable":true,"type":"string"},"gapBetweenDueDates":{"$ref":"#/components/schemas/DueDatesGap"},"originationFeeAPRCalcOverride":{"default":"noOverride","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the APR will be calculated as if the origination fee will be calculated per the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFeeChargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the APR will be calculated as if origination fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was collected at origination regardless of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFeeChargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["noOverride","atOrigination"],"type":"string"},"originationFeeChargeLogic":{"$ref":"#/components/schemas/FeeChargeLogic"}},"type":"object"}]}},"components/schemas/AmortizationMethod":{"id":"components/schemas/AmortizationMethod","kind":"json-schema","title":"AmortizationMethod","data":{"default":"equalPayments","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equalPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal (except maybe for the last payment)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most installment loans are expected to use this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal to interest only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the last payment will include the entire principal. Keep in mind that if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest.periodAccrualDurationType=actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the recurring payment amounts will be different every period for monthly and twice monthly frequencies. This is because a month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can have 28, 29, 30 or 31 days and interest accrued will vary based on the number of days in the month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are additional limitations to be aware for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For installment loans, Autopay can only be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aligned to due dates. It means that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay.allowedFrequency.isDueDatesAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This way the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will only allow Autopay to be aligned to the loan frequency and due dates."},"children":[]}]}]}],"enum":["equalPayments","interestPaymentsBalloonPrincipal","custom"],"type":"string"}},"components/schemas/LoanAssetType":{"id":"components/schemas/LoanAssetType","kind":"json-schema","title":"LoanAssetType","data":{"description":"The generic asset types that are supported.","enum":["personalClosedEndUnsecured","personalOpenEndUnsecured","personalClosedEndSecured","personalOpenEndSecured","motorMVRISC","motorDirect","motorLease","businessClosedEndUnsecured","businessOpenEndUnsecured","businessClosedEndSecured","businessOpenEndSecured"],"type":"string"}},"components/schemas/GenericInstallmentOriginationProperties":{"id":"components/schemas/GenericInstallmentOriginationProperties","kind":"json-schema","title":"GenericInstallmentOriginationProperties","data":{"allOf":[{"$ref":"#/components/schemas/GenericInstallmentOriginationPropertiesBase"},{"$ref":"#/components/schemas/GenericInstallmentOriginationPropertiesRates"}]}},"components/schemas/installmentLoanProperties":{"id":"components/schemas/installmentLoanProperties","kind":"json-schema","title":"Generic Installment Loan","data":{"allOf":[{"$ref":"#/components/schemas/GenericLoanConfigProperties"},{"properties":{"amortizationMethod":{"$ref":"#/components/schemas/AmortizationMethod"},"assetType":{"$ref":"#/components/schemas/LoanAssetType","readOnly":true},"atOrigination":{"$ref":"#/components/schemas/GenericInstallmentOriginationProperties"},"maxAPR":{"description":"Indicates whether the loan has a maximum APR\n","format":"float","nullable":true,"type":"number"},"periodAccrualDurationType":{"default":"actual","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - each period is assumed to be fixed number of calendar days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency we assume 30 days between any two consecutive due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency we assume 15 days between any two consecutive due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency we assume 14 days between any two consecutive due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency we assume 7 days between any two consecutive due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - we calculate actual number of days in a period. For example, for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number days in a period can be 28, 29, 30 or 31."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For line of credit we only support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["fixed","actual"],"nullable":true,"type":"string"},"periodType":{"default":"periodEnd","enum":["periodBegin","periodEnd"],"type":"string"},"singleTermUnitPeriod":{"default":"days","enum":["days","months","sixMonths","years"],"type":"string"}},"required":["atOrigination"],"type":"object"}],"title":"Generic Installment Loan"}},"components/schemas/lineOfCreditLoanProperties":{"id":"components/schemas/lineOfCreditLoanProperties","kind":"json-schema","title":"Generic Line of Credit","data":{"allOf":[{"$ref":"#/components/schemas/GenericLoanConfigProperties"},{"properties":{"amortizationMethod":{"$ref":"#/components/schemas/AmortizationMethod"},"assetType":{"$ref":"#/components/schemas/LoanAssetType","readOnly":true},"atOrigination":{"allOf":[{"$ref":"#/components/schemas/GenericLOCOriginationProperties"},{"$ref":"#/components/schemas/DrawProperties"}],"required":["startDate","amountFinanced","interestRates","paymentFrequency","drawDuration","drawStartDate"]},"drawFeeChargeLogic":{"$ref":"#/components/schemas/FeeChargeLogic"},"statementCloseToDueDatePeriod":{"default":14,"description":"Number of calendar days between statement close date and a due date.\nTypically, 14 or 21 days. Applicable for line of credit only.\n","nullable":true,"type":"integer"}},"required":["atOrigination"],"type":"object"}],"title":"Generic Line of Credit"}},"components/schemas/AmortizableLoan":{"id":"components/schemas/AmortizableLoan","kind":"json-schema","title":"AmortizableLoan","data":{"anyOf":[{"$ref":"#/components/schemas/predefinedInstallmentLoanProperties"},{"$ref":"#/components/schemas/predefinedLineOfCreditLoanProperties"},{"$ref":"#/components/schemas/installmentLoanProperties"},{"$ref":"#/components/schemas/lineOfCreditLoanProperties"}]}},"components/schemas/SingletonResponse":{"id":"components/schemas/SingletonResponse","kind":"json-schema","title":"SingletonResponse","data":{"properties":{"message":{"description":"Description of the server action or error.","type":"string"},"status":{"description":"HTTP status code.","type":"integer"}},"type":"object"}},"components/schemas/AmortizationLite":{"id":"components/schemas/AmortizationLite","kind":"json-schema","title":"AmortizationLite","data":{"description":"Amortization details","properties":{"fees":{"properties":{"originationFeeAmount":{"description":"The amount of the origination fee.\n","format":"float","nullable":true,"type":"number"},"totalOtherFeesAmount":{"description":"The total amount of non-origination fees that are expected to be charged on the loan.\n","format":"float","readOnly":true,"type":"number"}},"type":"object"},"interestRateBelowMinOrZero":{"description":"The interest rate is below the minimum annual interest rate.","type":"boolean"},"interestRateExceedsMax":{"description":"The interest rate exceeds the maximum annual interest rate.","type":"boolean"},"numberPayments":{"description":"The number of expected payment due dates.","type":"integer"},"periodicPaymentAmount":{"description":"The amortized periodic payment amount expected to be paid by the borrower on due dates.","format":"float","type":"number"},"totalDiscountAmount":{"description":"The total amount of discount at origination as a result of promo rates.\n","format":"float","type":"number"},"totalInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of interest the loan should accrue. Because of rounding issues, the total of expected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might be different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalInterestAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"totalPaymentsAmount":{"description":"The total amount of expected payments.","format":"float","type":"number"}},"type":"object"}},"components/schemas/Amortization":{"id":"components/schemas/Amortization","kind":"json-schema","title":"Amortization","data":{"allOf":[{"$ref":"#/components/schemas/AmortizationLite"},{"properties":{"amountFinanced":{"$ref":"#/components/schemas/AmountFinanced"},"schedule":{"items":{"properties":{"amount":{"description":"The amount of the expected payment.","format":"float","type":"number"},"date":{"description":"The due date of the expected payment.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this will contain details of the dynamic fee."},"children":[]}]}]}],"properties":{"apiName":{"description":"The API name of the dynamic fee. For example: 'lateFee' or 'breatherFee'.\n","type":"string"},"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the dynamic fee as shown to the borrower in the UI. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Late Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Breather Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"dynamicFeeTypeId":{"description":"The dynamic fee type identifier in the system.","type":"string"}},"type":"object"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"interestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"paymentType":{"description":"The payment type.","enum":["periodicPayment","originationFee","drawFee","dynamicFee","downPayment","discountCredit"],"type":"string"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"unroundedInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedInterestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount. Available only for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/InstallmentAmortization":{"id":"components/schemas/InstallmentAmortization","kind":"json-schema","title":"Installment amortization details","data":{"allOf":[{"properties":{"aprEffective":{"description":"The calculated effective APR for the loan.","format":"float","type":"number"},"aprEffectiveExceedsMax":{"description":"The effective APR exceeds the maximum APR.","type":"boolean"},"aprNominal":{"description":"The calculated nominal APR for the loan.","format":"float","type":"number"},"aprNominalExceedsMax":{"description":"The nominal APR exceeds the maximum APR.","type":"boolean"},"forgoneInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forgone interest amount due to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/Amortization"}],"description":"Installment amortization details","title":"Installment amortization details"}},"components/schemas/LineOfCreditAmortization":{"id":"components/schemas/LineOfCreditAmortization","kind":"json-schema","title":"Line of Credit amortization details","data":{"allOf":[{"$ref":"#/components/schemas/Amortization"}],"description":"Line of Credit loan amortization details","title":"Line of Credit amortization details"}},"components/schemas/AmortizationResult":{"id":"components/schemas/AmortizationResult","kind":"json-schema","title":"AmortizationResult","data":{"anyOf":[{"$ref":"#/components/schemas/InstallmentAmortization"},{"$ref":"#/components/schemas/LineOfCreditAmortization"}],"type":"object"}},"components/schemas/Combinations":{"id":"components/schemas/Combinations","kind":"json-schema","title":"Combinations","data":{"description":"The combinations of duration, interest rates, promo rates, and\nmaximum interest cap for the requested amount financed\n","items":{"allOf":[{"properties":{"combinationId":{"description":"The identifier of this specific amortization combination\nof duration, interest rates, promo rates and total\ninterest cap amount.\n","nullable":false,"type":"string"}},"required":["combinationId"],"type":"object"},{"$ref":"#/components/schemas/GenericInstallmentOriginationPropertiesRates"}]},"nullable":false,"type":"array"}},"components/schemas/AmortizeCombinationsBody":{"id":"components/schemas/AmortizeCombinationsBody","kind":"json-schema","title":"AmortizeCombinationsBody","data":{"allOf":[{"$ref":"#/components/schemas/LoanTypeId"},{"properties":{"atOrigination":{"allOf":[{"$ref":"#/components/schemas/PredefinedInstallmentLoanAtOriginationBase"},{"properties":{"combinations":{"$ref":"#/components/schemas/Combinations"}},"required":["combinations"],"type":"object"}]}},"required":["loanTypeId","atOrigination"],"type":"object"}]}},"components/schemas/AmortizationCombinationsResult":{"id":"components/schemas/AmortizationCombinationsResult","kind":"json-schema","title":"AmortizationCombinationsResult","data":{"items":{"allOf":[{"properties":{"combinationId":{"nullable":false,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AmortizationLite"},{"properties":{"forgoneInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forgone interest amount due to the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}]},"nullable":false,"type":"array"}},"components/schemas/AnyId":{"id":"components/schemas/AnyId","kind":"json-schema","title":"AnyId","data":{"description":"Peach's unique or lender's external identifier.","pattern":"^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string","writeOnly":true}},"components/schemas/UserPermissions":{"id":"components/schemas/UserPermissions","kind":"json-schema","title":"UserPermissions","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User permissions per company. An object keyed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s as strings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a list of strings indicating the permissions the user has within that company."},"children":[]}]}]}],"items":{"description":"permissions","type":"string"},"type":"array","x-additionalPropertiesName":"companyId"},"type":"object"}},"components/schemas/AuthSuccess":{"id":"components/schemas/AuthSuccess","kind":"json-schema","title":"AuthSuccess","data":{"properties":{"token":{"type":"string"}},"required":["token"],"type":"object"}},"components/schemas/UserType":{"id":"components/schemas/UserType","kind":"json-schema","title":"UserType","data":{"description":"The type of the user.","enum":["agent","borrower","service"],"type":"string"}},"components/schemas/AuthType":{"id":"components/schemas/AuthType","kind":"json-schema","title":"AuthType","data":{"enum":["basic","google","oneTimeCodeEmail","oneTimeCodeText","SAML"],"type":"string"}},"components/schemas/AuthValueType":{"id":"components/schemas/AuthValueType","kind":"json-schema","title":"AuthValueType","data":{"enum":["email","username","phone","samlSubjectNameId"],"type":"string"}},"components/schemas/UserInfo":{"id":"components/schemas/UserInfo","kind":"json-schema","title":"UserInfo","data":{"properties":{"data":{"properties":{"firstName":{"description":"The user's first name.","type":"string"},"lastName":{"description":"The user's last name.","type":"string"},"username":{"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/AppDomainType":{"id":"components/schemas/AppDomainType","kind":"json-schema","title":"AppDomainType","data":{"enum":["borrower","agent","help","admin"],"type":"string"}},"components/schemas/CompanyConfigBrandAssets":{"id":"components/schemas/CompanyConfigBrandAssets","kind":"json-schema","title":"CompanyConfigBrandAssets","data":{"description":"Brand assets and colors","properties":{"colors":{"nullable":true,"properties":{"button":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the button color"},"children":[]}]}]}],"nullable":true,"type":"string"},"lighten":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the lighten color"},"children":[]}]}]}],"nullable":true,"type":"string"},"link":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the link color"},"children":[]}]}]}],"nullable":true,"type":"string"},"primary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the primary color"},"children":[]}]}]}],"nullable":true,"type":"string"},"secondButton":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the second button foreground color"},"children":[]}]}]}],"nullable":true,"type":"string"},"secondButtonBackground":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the second button background color"},"children":[]}]}]}],"nullable":true,"type":"string"},"secondary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the secondary color"},"children":[]}]}]}],"nullable":true,"type":"string"},"tertiary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color string (#000ccc) representing the tertiary color"},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"},"copies":{"nullable":true,"properties":{"consent":{"description":"HTML of the consent appearing in the footer","nullable":true,"type":"string"},"disclosures":{"description":"HTML of the disclosures appearing in the footer","nullable":true,"type":"string"}},"type":"object"},"logos":{"nullable":true,"properties":{"appCompactNavigation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the compact/mobile navigation logo. Recommended dimensions: 200×32px."},"children":[]}]}]}],"nullable":true,"type":"string"},"appLargeCentered":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the large centered logo (e.g. login, document upload). Recommended dimensions: 400×64px."},"children":[]}]}]}],"nullable":true,"type":"string"},"appRegularNavigation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the desktop navigation logo. Recommended dimensions: 304×48px."},"children":[]}]}]}],"nullable":true,"type":"string"},"primary":{"description":"URL To the primary logo","nullable":true,"type":"string"},"small":{"description":"URL to the small logo","nullable":true,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/CompanyConfigEmailStringOrObject":{"id":"components/schemas/CompanyConfigEmailStringOrObject","kind":"json-schema","title":"CompanyConfigEmailStringOrObject","data":{"oneOf":[{"description":"The email address","example":"jondoe@example.com","title":"Plain Email","type":"string"},{"example":{"email":"jondoe@example.com","name":"Jon Doe"},"properties":{"email":{"type":"string"},"name":{"description":"Name associated with email address","nullable":true,"type":"string"}},"title":"Name + Email","type":"object"},{"example":{"email":"jondoe@example.com","name":"Jon Doe"},"properties":{"address":{"example":"jondoe@example.com","type":"string"},"name":{"description":"Name associated with email address","nullable":true,"type":"string"}},"title":"Name + Address","type":"object"}]}},"components/schemas/CompanyConfigCommunication":{"id":"components/schemas/CompanyConfigCommunication","kind":"json-schema","title":"CompanyConfigCommunication","data":{"properties":{"address_from":{"$ref":"#/components/schemas/AddressBase","description":"The from address of letters sent out."},"email_from":{"oneOf":[{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},{"description":"Configure email addresses from which to send email messages","properties":{"non_transactional_from":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},{"description":"The email address from which all non-transactional emails are sent.\n\nA non-transactional email are those which are sent manually by\nan agent in the CRM.\n"}]},"non_transactional_reply_to":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reply-to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sent non-transactional emails."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-transactional email are those which are sent manually by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an agent in the CRM."},"children":[]}]}]}]}]},"skipCGRules":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can-interact will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this company without checking Compliance Guard rules"},"children":[]}]}]}],"type":"boolean"},"transactional_from":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},{"description":"The email address from which all transactional emails are sent.\n\nA transactional email are those which are NOT sent manually by\nan agent in the CRM.\n"}]},"transactional_reply_to":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reply-to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sent transactional emails."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transactional email are those which are NOT sent manually by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an agent in the CRM."},"children":[]}]}]}]}]}},"title":"From and Reply-To","type":"object"}]},"email_inbound":{"description":"Configure email addresses which may be used to receive messages.","properties":{"monitored_emails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of email addresses which can receive incoming email messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An incoming email message will create a Taskrouter Task:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandleInboundInteraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandleUnboundInboundInteraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CompanyConfigEmailStringOrObject"},"type":"array"},"reject_others":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then all email messages received by the email system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which are NOT present in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitored_emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are considered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"unmonitored email addresses\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unmonitored email addresses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when receiving an email message DO NOT create Taskrouter Tasks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when an email message is received, automatically reply with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an email saying that they have messaged an \"unmonitored\" email."},"children":[]}]}]}]}],"type":"boolean"}},"type":"object"},"enableInboundVoiceCall":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable inbound voice calls. Otherwise, inbound callers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are read a voicemail is currently disabled message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Note that other configuration settings must be set for voice calls"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to work properly.)"},"children":[]}]}]}],"type":"boolean"},"enableInboundWebChat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable inbound webchats."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the Contact Us page will display a link to start a webchat"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for logged-in borrowers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be configured for inbound webchats to work."},"children":[]}]}]}],"type":"boolean"},"enable_two_way_texting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable inbound text receipt and responses. Otherwise, texter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive response saying \"This number is not monitored...\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(To configure the autoresponse message see the config setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support.textSupportDisabledMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound text messages will generate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replyToNewText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-type tasks."},"children":[]}]}]}],"type":"boolean"},"text_from_number":{"description":"The phone number to send text messages from.","example":"+18085551234","type":"string"}},"type":"object"}},"components/schemas/CompanyConfigEvidence":{"id":"components/schemas/CompanyConfigEvidence","kind":"json-schema","title":"CompanyConfigEvidence","data":{"properties":{"captureScreenshot":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", capture payment screenshot for evidence collection."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/CompanyConfigLinks":{"id":"components/schemas/CompanyConfigLinks","kind":"json-schema","title":"CompanyConfigLinks","data":{"properties":{"eSignDisclosureUrl":{"description":"URL of lender's eSign Disclosure page","format":"url","nullable":true,"type":"string"},"helpUrl":{"description":"URL of lender's help page","format":"url","nullable":true,"type":"string"},"privacyPolicyUrl":{"description":"URL of lender's Privacy Policy page","format":"url","nullable":true,"type":"string"},"termsOfUseUrl":{"description":"URL of lender's Terms of Use page","format":"url","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/CompanyConfigOpenHours":{"id":"components/schemas/CompanyConfigOpenHours","kind":"json-schema","title":"CompanyConfigOpenHours","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object describing the times in which this company is \"open\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used in multiple places:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is displayed on the contact us page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When closed, phone calls are sent to voicemail or rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When closed, webchats cannot be started."},"children":[]}]}]}]}],"nullable":true,"properties":{"businessHours":{"nullable":true,"properties":{"holidays":{"description":"The list of holidays on which the company has special open hours. Holiday\nhours supercede the \"normal\" weekly hours.\n","items":{"oneOf":[{"description":"An object describing the holiday.\n\nNote that repeating, annual holidays cannot currently be specified; you must\nspecify each year's holiday.\n","properties":{"date":{"description":"An ISO 8601 date (not date-time) on which this holiday occurs\n","example":"2024-04-01","type":"string"},"hours":{"description":"The hours in which the company is open on this holiday","example":"09:00-15:00","type":"string"},"name":{"description":"The name of the holiday","example":"April Fools Day","type":"string"}},"required":["name"],"title":"Custom Holiday","type":"object"},{"description":"An object indicating this company should match \"standard\" holidays\nfor the country indicated.\n\nNote that adding this will add multiple holidays to your open hours\nconfiguration.\n","properties":{"hours":{"description":"The hours in which the company is open on these holidays","example":"Closed","type":"string"},"matchCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166 2 or 3 character country code of the country to match."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of holidays for a country matches those used by the python"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package \"Holidays\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See: https://python-holidays.readthedocs.io/"},"children":[]}]}]}],"example":"GB","type":"string"}},"required":["matchCountry"],"title":"Match Country Holidays","type":"object"}]},"nullable":true,"type":"array"},"normal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specially formatted string describing the open hours of the company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A day-time descriptor is a day or days of the week followed by a space \" \""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and an \"hours\". With a \"day\" being the first three letters of the day of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the week. With \"hours\" being either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a 24-hour time range like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9:00-18:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Mon-Wed 3:00-13:00\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an open time from 3am to 1pm on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monday, Tuesday, and Wednesday."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Fri 24hrs\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that on Friday the company is open for 24 hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Thu closed\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates on Thursday the company is closed all day."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day-time descriptors can be combined with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fully define a week"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of open times."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no open hours are configured the company is considered always closed."},"children":[]}]}]}],"example":"Mon 24hrs; Tue-Fri 9:00-18:00; Sat-Sun Closed","nullable":true,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/CompanyConfigPaymentTypes":{"id":"components/schemas/CompanyConfigPaymentTypes","kind":"json-schema","title":"CompanyConfigPaymentTypes","data":{"description":"Controls what payment instrument types are allowed.","properties":{"ach":{"default":false,"type":"boolean"},"achVerification":{"properties":{"microdeposit":{"description":"Microdeposit verification is required when creating bank accounts without using Plaid.","type":"boolean"},"plaid":{"description":"Plaid account creation is allowed.","type":"boolean"}},"type":"object"},"balanceCheck":{"properties":{"plaid":{"description":"Allow Plaid balance checks.","type":"boolean"}},"type":"object"},"check":{"default":false,"type":"boolean"},"creditCard":{"default":false,"type":"boolean"},"debitCard":{"default":false,"type":"boolean"},"moneyOrder":{"default":false,"type":"boolean"},"paymentNetwork":{"default":false,"type":"boolean"},"payroll":{"default":false,"type":"boolean"},"wire":{"default":false,"type":"boolean"}},"type":"object"}},"components/schemas/CompanyConfigStatements":{"id":"components/schemas/CompanyConfigStatements","kind":"json-schema","title":"CompanyConfigStatements","data":{"properties":{"defaultStatementChannel":{"enum":["email","mail"],"type":"string"},"isMailStatementAllowed":{"description":"Whether borrowers can choose mail as their delivery method for statements.\n","type":"boolean"},"overdueAmountInMinPaymentOverride":{"description":"If true, include the overdue amount in the min payment calculation during statement generation. This is also the default.\n\nIf false, do not include the overdue amount in the min payment calculation during statement generation.\n","nullable":true,"type":"boolean"}},"type":"object"}},"components/schemas/CompanyConfigSupport":{"id":"components/schemas/CompanyConfigSupport","kind":"json-schema","title":"CompanyConfigSupport","data":{"description":"Customer support","properties":{"departmentName":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"enableVoicemailWhenClosed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the leaving of voicemails when a customer calls"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"while phone support is closed."},"children":[]}]}]}],"type":"boolean"},"enableVoicemailWhenNoAgents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable leaving of voicemails when a customer calls"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when there are no agents available to answer the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or left unset the caller will remain on hold indefinitely until"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an agent makes themselves available."},"children":[]}]}]}],"type":"boolean"},"mailingAddress":{"$ref":"#/components/schemas/AddressBase","description":"The mailing address of the support department.","nullable":true},"outboundCallRecordingConsentScript":{"description":"Message to read to caller when making an outbound call to obtain consent\nto record the call.\n","type":"string"},"phone":{"nullable":true,"type":"string"},"phoneSupportClosedLeaveVoicemailMessage":{"description":"Message to read to caller when phone support is closed, and they may leave a message.\n","type":"string"},"phoneSupportClosedMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message to read to caller when phone support is closed (and voicemails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be left because "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enableVoicemailWhenClosed=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"phoneSupportDisabledMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message to read in response to an inbound call when phone support is disabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Phone support is disabled with the company config setting: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communication.enableInboundVoiceCall=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"phoneSupportNoAgentsLeaveVoicemailMessage":{"description":"Message to read to caller when there are no agents available, and\nthey may leave a message.\n","type":"string"},"phoneSupportPleaseHoldMessage":{"description":"Message to read to inbound callers when being put on hold. This message is read\nafter the recording consent message.\n","type":"string"},"privacyPolicyUrl":{"description":"URL of the privacy policy notice.","nullable":true,"type":"string"},"recordAllInboundVoiceCalls":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to record all inbound voice calls. Otherwise, calls can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be manually recorded on an individual basis by an agent."},"children":[]}]}]}],"type":"boolean"},"recordAllOutboundVoiceCalls":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to record all outbound voice calls. Otherwise, calls can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be manually recorded on an individual basis by an agent."},"children":[]}]}]}],"type":"boolean"},"textSupportClosedPleaseWaitMessage":{"description":"Message to send in response to initial inbound text message which starts a text message\nconversation when phone support is closed.\n","type":"string"},"textSupportDisabledMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message to send in response to an inbound text message when text support is disabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Text support is disabled with the company config setting: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communication.enable_two_way_texting=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"textSupportFindNewAgentPleaseWaitMessage":{"description":"Message to send in response to an inbound text message to an already active conversation,\nin which there is NOT already an agent.\n","type":"string"},"textSupportPleaseWaitMessage":{"description":"Message to send in response to initial inbound text message which starts a text message\nconversation.\n","type":"string"},"textSupportRejectUnknownNumberMessage":{"description":"Message to send in response to an inbound text message when rejecting contact from\nan unknown number.\n","type":"string"}},"type":"object"}},"components/schemas/CompanyConfigTimezone":{"id":"components/schemas/CompanyConfigTimezone","kind":"json-schema","title":"CompanyConfigTimezone","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timezone of the company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can be any IANA timezone from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://data.iana.org/time-zones/releases/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timezone database"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this value should be a timezone and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a UTC Offset. A timezone is associated with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a geographic place / political entity (e.g., \"America/Los_Angeles\"), a UTC Offset"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is just a count of number of hours difference from UTC."},"children":[]}]}]}],"nullable":true,"type":"string"}},"components/schemas/HiddenOrNull":{"id":"components/schemas/HiddenOrNull","kind":"json-schema","title":"HiddenOrNull","data":{"enum":["hidden"],"nullable":true,"type":"string"}},"components/schemas/AgentDashboardTools":{"id":"components/schemas/AgentDashboardTools","kind":"json-schema","title":"AgentDashboardTools","data":{"properties":{"dashboardToolDetails":{"description":"The details required for Peach to expose the agent tools to agents.","items":{"properties":{"name":{"description":"The name of the tool displayed to the agent.","type":"string"},"url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The url associated with the agent tool. This controls the destination where the agent is taken when they access"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the tool."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: when creating the url, there are parameters that the system will be able to parse and automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fill in. They are {borrowerId}, {externalBorrowerId}, {loanId}, {loanExternalId}, {loanPeachPublicId}, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{borrowerPeachPublicId}"},"children":[]}]}]}],"type":"string"}},"type":"object"},"type":"array"},"enabled":{"default":false,"description":"Determines whether agent tools will be shown in the loan options menu to the agent.","type":"boolean"}},"type":"object"}},"components/schemas/ShownOrNull":{"id":"components/schemas/ShownOrNull","kind":"json-schema","title":"ShownOrNull","data":{"enum":["shown"],"nullable":true,"type":"string"}},"components/schemas/CompanyConfigUi":{"id":"components/schemas/CompanyConfigUi","kind":"json-schema","title":"CompanyConfigUi","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure UI, including the visibility or ordering of various UI"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"elements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each element is either hidden or visible by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For elements shown by default, hide them by setting their value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For elements hidden by default, show them by setting their value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These elements are hidden by default:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"directPaymentToDraw"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other elements are shown by default."},"children":[]}]}]}],"properties":{"accountSettings":{"$ref":"#/components/schemas/HiddenOrNull"},"accountSettingsPage":{"properties":{"additionalContacts":{"$ref":"#/components/schemas/HiddenOrNull"},"commPreferences":{"$ref":"#/components/schemas/HiddenOrNull"},"contactInformation":{"$ref":"#/components/schemas/HiddenOrNull"},"paymentMethods":{"$ref":"#/components/schemas/HiddenOrNull"},"profile":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"accountSummaryPage":{"properties":{"balancesDetails":{"$ref":"#/components/schemas/HiddenOrNull"},"cardDetails":{"$ref":"#/components/schemas/HiddenOrNull"},"loanTerms":{"$ref":"#/components/schemas/HiddenOrNull"},"merchantDetails":{"$ref":"#/components/schemas/HiddenOrNull"},"promotions":{"$ref":"#/components/schemas/HiddenOrNull"},"summary":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"agentDashboardTools":{"$ref":"#/components/schemas/AgentDashboardTools"},"analyticsScript":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTML portion of script codes that loads analytics related code. The code is merged at the bottom of the main HTML page. Double quotes (\") should be encoded by prefixing it with a \"\\\" (backslash)."},"children":[]}]}]}],"type":"string"},"caseTypeOrdering":{"description":"Definitions for case type selection dropdown grouping and\nordering. Categories and tasks are ordered as given.\n","items":{"properties":{"caseTypes":{"description":"Array of case type Peach IDs","items":{"$ref":"#/components/schemas/AnyId"},"type":"array"},"category":{"description":"Category name","type":"string"}},"type":"object"},"type":"array"},"contactUs":{"$ref":"#/components/schemas/HiddenOrNull"},"dashboard":{"description":"Configuration for the embedded Metabase dashboards displayed in CRM.\n","properties":{"cases":{"$ref":"#/components/schemas/HiddenOrNull","description":"Hide the cases embedded Metabase dashboard in CRM."},"interactions":{"$ref":"#/components/schemas/HiddenOrNull","description":"Hide the interactions embedded Metabase dashboard in CRM."}},"type":"object"},"directPaymentToDraw":{"$ref":"#/components/schemas/ShownOrNull","description":"Allow customers to direct manual payments toward a specific draw.\nOnly applicable to LOC.\n"},"eSignDisclosure":{"$ref":"#/components/schemas/HiddenOrNull"},"favicon":{"description":"URL of the company favicon.","nullable":true,"type":"string"},"headScripts":{"description":"The HTML portion that is loaded at the top of the tag of the main HTML page. Can be used to inject additional scripts that must be loaded at the start, like UserWay's ADA compliance widget.","type":"string"},"help":{"$ref":"#/components/schemas/HiddenOrNull"},"loanOptions":{"properties":{"changeDueDate":{"$ref":"#/components/schemas/HiddenOrNull"},"changeNickname":{"$ref":"#/components/schemas/HiddenOrNull"},"drawFunds":{"$ref":"#/components/schemas/HiddenOrNull"},"getPayoffStatement":{"$ref":"#/components/schemas/HiddenOrNull"},"makePayment":{"$ref":"#/components/schemas/HiddenOrNull"},"manageAutopay":{"$ref":"#/components/schemas/HiddenOrNull"},"managePaymentMethods":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"loginPage":{"properties":{"fallbackAuthLink":{"$ref":"#/components/schemas/HiddenOrNull","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the UI will hide hide the \"Try another way to login\" link."},"children":[]}]}]}]}},"type":"object"},"makePaymentPage":{"properties":{"remainingBalance":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"manageAutopayPage":{"properties":{"minimumPaymentDue":{"$ref":"#/components/schemas/HiddenOrNull"},"statementBalance":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"managePaymentMethodsPage":{"properties":{"agent":{"properties":{"check":{"$ref":"#/components/schemas/HiddenOrNull"},"creditCard":{"$ref":"#/components/schemas/HiddenOrNull"},"debitCard":{"$ref":"#/components/schemas/HiddenOrNull"},"deleteButton":{"$ref":"#/components/schemas/HiddenOrNull"},"moneyOrder":{"$ref":"#/components/schemas/HiddenOrNull"},"paymentNetwork":{"$ref":"#/components/schemas/HiddenOrNull"},"payroll":{"$ref":"#/components/schemas/HiddenOrNull"},"wire":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"},"borrower":{"properties":{"check":{"$ref":"#/components/schemas/HiddenOrNull"},"creditCard":{"$ref":"#/components/schemas/HiddenOrNull"},"debitCard":{"$ref":"#/components/schemas/HiddenOrNull"},"deleteButton":{"$ref":"#/components/schemas/HiddenOrNull"},"moneyOrder":{"$ref":"#/components/schemas/HiddenOrNull"},"paymentNetwork":{"$ref":"#/components/schemas/HiddenOrNull"},"payroll":{"$ref":"#/components/schemas/HiddenOrNull"},"wire":{"$ref":"#/components/schemas/HiddenOrNull"}},"type":"object"}},"type":"object"},"mobileDisclosures":{"$ref":"#/components/schemas/HiddenOrNull","description":"Hide the borrower portal disclosures on mobile devices.\n"},"mobileFooter":{"$ref":"#/components/schemas/HiddenOrNull","description":"Hide the borrower portal footer on mobile devices.\n"},"mobileHeader":{"$ref":"#/components/schemas/HiddenOrNull","description":"Hide the borrower portal header on mobile devices.\n"},"phoneDisclosureNote":{"$ref":"#/components/schemas/ShownOrNull","description":"Controls whether a fixed disclosure note is shown on the Borrower Portal when a borrower changes their primary or personal phone number. Absent or null means hidden (default).\n"},"privacyPolicy":{"$ref":"#/components/schemas/HiddenOrNull"},"projectSlug":{"description":"The company project slug used to serve the UI. Please do NOT change it without coordinating with engineering.","type":"string"},"signOut":{"$ref":"#/components/schemas/HiddenOrNull"},"termsOfUse":{"$ref":"#/components/schemas/HiddenOrNull"},"websiteTitle":{"description":"The title that will be shown when the front end loads before the rest of the code loads.","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/FrontendPreauthBootstrap":{"id":"components/schemas/FrontendPreauthBootstrap","kind":"json-schema","title":"FrontendPreauthBootstrap","data":{"properties":{"appDomainType":{"$ref":"#/components/schemas/AppDomainType"},"authType":{"$ref":"#/components/schemas/AuthType"},"authValueType":{"$ref":"#/components/schemas/AuthValueType"},"company":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The values in here "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO NOT directly correspond"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the values returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/companies/{companyId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. These values are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"similar"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transformed for public consumption."},"children":[]}]}]}],"properties":{"agentAuthType":{"$ref":"#/components/schemas/AuthType"},"agentAuthValueType":{"$ref":"#/components/schemas/AuthValueType"},"borrowerAuthType":{"$ref":"#/components/schemas/AuthType"},"borrowerAuthValueType":{"$ref":"#/components/schemas/AuthValueType"},"brandAssets":{"$ref":"#/components/schemas/CompanyConfigBrandAssets"},"brandName":{"type":"string"},"communication":{"$ref":"#/components/schemas/CompanyConfigCommunication"},"defaultVerificationTypeId":{"type":"string"},"domainName":{"type":"string"},"evidence":{"$ref":"#/components/schemas/CompanyConfigEvidence"},"forceCaseIdOnAgentActions":{"type":"boolean"},"id":{"type":"string"},"legalName":{"type":"string"},"links":{"$ref":"#/components/schemas/CompanyConfigLinks"},"name":{"type":"string"},"openHours":{"$ref":"#/components/schemas/CompanyConfigOpenHours"},"paymentTypes":{"$ref":"#/components/schemas/CompanyConfigPaymentTypes"},"shortDomainName":{"type":"string"},"showPoweredByPeach":{"nullable":true,"type":"boolean"},"statements":{"$ref":"#/components/schemas/CompanyConfigStatements"},"support":{"$ref":"#/components/schemas/CompanyConfigSupport"},"tasks":{"properties":{"enableCaseOwnership":{"type":"boolean"}},"type":"object"},"timezone":{"$ref":"#/components/schemas/CompanyConfigTimezone"},"ui":{"$ref":"#/components/schemas/CompanyConfigUi"}},"type":"object"},"ssoLoginUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSO login URL to send the requester to if this is an SSO-authenticated application,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"userType":{"$ref":"#/components/schemas/UserType"}},"type":"object"}},"components/schemas/NewPaginator":{"id":"components/schemas/NewPaginator","kind":"json-schema","title":"NewPaginator","data":{"properties":{"count":{"description":"Number of items returned by the current request.","readOnly":true,"type":"integer"},"nextUrl":{"description":"URL of the next set of results.","nullable":true,"readOnly":true,"type":"string"},"previousUrl":{"description":"URL of the previous set of results.","nullable":true,"readOnly":true,"type":"string"},"status":{"description":"HTTP status code.","type":"integer"},"total":{"description":"Total number of items in this result.","readOnly":true,"type":"integer"}},"type":"object"}},"components/schemas/BaseMixin":{"id":"components/schemas/BaseMixin","kind":"json-schema","title":"BaseMixin","data":{"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/BaseWithExternalIdMixin":{"id":"components/schemas/BaseWithExternalIdMixin","kind":"json-schema","title":"BaseWithExternalIdMixin","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for an object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ABCDE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"maxLength":200,"minLength":1,"nullable":true,"type":"string"}},"type":"object"}]}},"components/schemas/BulkSenderInteractionChannel":{"id":"components/schemas/BulkSenderInteractionChannel","kind":"json-schema","title":"BulkSenderInteractionChannel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel to which the bulk sender will send."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no channel is specified the campaign will send to all channels with a defined template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are compatible with the campaigns system."},"children":[]}]}]}],"enum":["voice","email","fax","text","chat","mail","gui","document"],"nullable":true,"type":"string"}},"components/schemas/InteractionSubject":{"id":"components/schemas/InteractionSubject","kind":"json-schema","title":"InteractionSubject","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subject of the interaction. The subject identifies the category of the content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most subjects have an associated implicit theme. e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOverdueFirstNotice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a theme of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For these subjects it is not necessary to specify a theme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some subjects like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeForm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom<N>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not have an implicit theme. When"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using these subjects you must specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locStatementGenerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locStatementRegenerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They will be automatically converted into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementGenerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementRegenerated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"respectively. You should switch to use those subjects directly."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failedSettlementPeach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated. This was always a subject used by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Peach application internally, and will no longer be used. Attempts to set this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subject will be rejected with a 400 error."},"children":[]}]}]}],"enum":["annualPrivacyPolicyNotice","autopayAgreement","autopayAmountChanged","autopayCanceledBySystem","autopayEnabled","autopayEnableReminder","autopayPaymentCanceled","autopayPaymentMethodUpdated","autopayPaymentReminder","autopayPaymentRescheduled","cardExpiresReminder","caseEscalation","ceaseCommunicationAcknowledgement","ceaseCommunicationRefuseToPay","confirmationCode","contactTakeover","creditNegativeInfoReported","creditPositiveInfoReported","custom1","custom2","custom3","custom4","custom5","custom6","custom7","custom8","custom9","custom10","custom11","custom12","custom13","custom14","custom15","custom16","custom17","custom18","custom19","custom20","custom21","custom22","custom23","custom24","custom25","custom26","custom27","custom28","custom29","custom30","custom31","custom32","custom33","custom34","custom35","custom36","custom37","custom38","custom39","custom40","custom41","custom42","custom43","custom44","custom45","custom46","custom47","custom48","custom49","custom50","custom51","custom52","custom53","custom54","custom55","custom56","custom57","custom58","custom59","custom60","custom61","custom62","custom63","custom64","custom65","custom66","custom67","custom68","custom69","custom70","custom71","custom72","custom73","custom74","custom75","custom76","custom77","custom78","custom79","custom80","custom81","custom82","custom83","custom84","custom85","custom86","custom87","custom88","custom89","custom90","custom91","custom92","custom93","custom94","custom95","custom96","custom97","custom98","custom99","custom100","debtValidationNotice","debtValidationNoticeArizona","debtValidationNoticeAutomatic","debtValidationNoticeNYCYonkers","debtValidationNoticePuertoRico","deceasedConfirmationOfPayoff","deceasedNoticeToRepresentative","deceasedNotificationUponDeath","disputeOfDebtConfirmed","disputeOfDebtSubmitDocumentation","disputeOfDebtSubmitDocumentationReminder","disputeOfDebtUnableToConfirm","disputeOfDebtUnableToResolve","documentUploadFailed","downpaymentFailed","drawFundsDisclosure","electronicConsentOptOut","failedSettlementInvestor","failedSettlementPeach","freeForm","freeFormBranded","futurepayCanceled","futurepayPaymentDueReminder","identityTheftIncompleteDocumentation","identityTheftNotValidated","identityTheftSubmitDocumentation","identityTheftSubmitDocumentationFirstReminder","identityTheftSubmitDocumentationSecondReminder","identityTheftValidated","letterReturnedToSender","loanAccelerated","loanCanceled","loanChargedOffUnsecured","loanDetails","loanFeeCharged","loanFreeze","loanManualPaymentDisclosure","loanOverdueFifthNotice","loanOverdueFirstNotice","loanOverdueFourthNotice","loanOverdueSecondNotice","loanOverdueSixthNotice","loanOverdueThirdNotice","loanPaidOff","loanPaymentScheduleChanged","loanPayoffStatement","loanRefundProcessed","loanRightToCurePersonalUnsecured","loanRightToCurePersonalUnsecuredColorado","loanRightToCurePersonalUnsecuredDC","loanRightToCurePersonalUnsecuredIowa","loanRightToCurePersonalUnsecuredKansas","loanRightToCurePersonalUnsecuredMaine","loanRightToCurePersonalUnsecuredMissouri","loanRightToCurePersonalUnsecuredSouthCarolina","loanRightToCurePersonalUnsecuredWestVirginia","loanRightToCurePersonalUnsecuredWisconsin","loanTermsChangeAgreement","loanUnfreeze","locCreditLimitChanged","locInterestRateChanged","locLineClosed","locStatementGenerated","locStatementRegenerated","loginFirstPaymentReminder","microdepositFailed","microdepositProcessing","microdepositReminder","oneTimeCode","paydayConsumerRightsNotice","paydayFirstPaymentWithdrawal","paymentDisputed","paymentDueDateReminder","paymentFailed","paymentMethodAdded","paymentMethodUpdated","paymentProcessing","paymentRescheduled","paymentReversalFailed","paymentReversalProcessing","paymentSuccessful","payoffStatementDocument","promiseToPayPeriodKept","promiseToPayPeriodMissed","promiseToPayPlanCanceled","promiseToPayPlanCreated","promoProgramCanceled","promoProgramEligibilityAtRisk","promoProgramExercised","promoProgramReminder","reimbursementFailed","reimbursementProcessed","reimbursementScheduled","scraApplicationDenied","scraBenefitsApplied","scraBenefitsExpiringNotice","scraCGFlaggedDocumentRequest","scraServicemanNotifiedDocumentRequest","settlementOffer","settlementOfferFirstReminder","statement","statementLOC","statementGenerated","statementRegenerated","unmonitoredEmailAddress","updateBankAccountConnection"],"type":"string"}},"components/schemas/InteractionTheme":{"id":"components/schemas/InteractionTheme","kind":"json-schema","title":"InteractionTheme","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why an interaction occurred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An outbound debt collection call should be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An annual privacy policy update email should be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsServicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer service response to borrower's inquiry should be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsServicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbBug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbHumanLove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsServicingNegativeCreditReportNotice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are deprecated:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you cannot create or update interactions to have these values."},"children":[]}]}]}],"enum":["agentNotification","opsCollDebt","opsCollLocateBorrower","opsCollVerifyEmployment","opsCollContactEmployerNotice","opsServicingDebtValidation","opsServicingNegativeCreditReportNotice","opsServicingTimeBarredNotice","opsServicing","opsAccountCredentials","inbMissingFeature","inbEducation","inbBug","inbRequest","inbHumanLove","inbUnknown","inbOther","inbServicing","inbCollections","inbPayments","inbFraud","inbGeneralInquiry"],"nullable":true,"type":"string"}},"components/schemas/BulkSender":{"id":"components/schemas/BulkSender","kind":"json-schema","title":"BulkSender","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"interactionChannel":{"$ref":"#/components/schemas/BulkSenderInteractionChannel"},"interactionSubject":{"$ref":"#/components/schemas/InteractionSubject"},"interactionTheme":{"$ref":"#/components/schemas/InteractionTheme"}},"type":"object"}]}},"components/schemas/BulkSenderCreate":{"id":"components/schemas/BulkSenderCreate","kind":"json-schema","title":"BulkSenderCreate","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"interactionChannel":{"$ref":"#/components/schemas/BulkSenderInteractionChannel"},"interactionSubject":{"$ref":"#/components/schemas/InteractionSubject"},"interactionTheme":{"$ref":"#/components/schemas/InteractionTheme"}},"required":["interactionSubject"],"type":"object"}]}},"components/schemas/LoansFromCollCase":{"id":"components/schemas/LoansFromCollCase","kind":"json-schema","title":"LoansFromCollCase","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", look up the associated collections case for this borrower,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and, if it exists, use the loans in collections as input to this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This cannot be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are no loans in collections for this borrower (i.e., no collections case),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this endpoint executes normally as if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" were not provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrowers may only have one collections case at a time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will mostly only be useful with collections-related themes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollLocateBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollVerifyEmployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollContactEmployerNotice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it is permissible to use with other themes."},"children":[]}]}]}]}],"type":"boolean"}},"components/schemas/ContactExporter":{"id":"components/schemas/ContactExporter","kind":"json-schema","title":"ContactExporter","data":{"description":"A contact exporter represents instructions on how to transform a\ncampaign run into a finalized list.\n","properties":{"checkCanInteractData":{"description":"If set, screen contacts through Compliance Guard using provided data.\n","nullable":true,"properties":{"isAutodialed":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if an autodialed call. If no value is passed, we'll assume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isAutodialed="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—meaning a manual call was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on why this is important reference the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telephone Consumer Protection Act (TCPA)."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"loansFromCollCase":{"$ref":"#/components/schemas/LoansFromCollCase"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"type":"object"},"columnSettings":{"description":"A list of dictionaries where each dictionary specifies a field to include as a column in the result\nfile along with optional output column name.\n","items":{"properties":{"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of the data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields are relative to "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the contact"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". i.e., the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the contact's ID, and not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the associated borrower's ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that fields prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are fields which will always return information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about this contact's associated borrower. For example, if the contact has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affiliation=spouse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerDateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will contain the borrower's date of birth, and NOT contain the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower's spouse's date of birth."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the following values are currently supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affiliation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's affiliation with the borrower. For example, if this were a borrower's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lawyer contact, this value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; Or, if this were a borrower's own contact it would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's external ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it does not have one."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's ID—starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CT-..."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's label—one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"military"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's full name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This contact's status—one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated Borrower Metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerCrmUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's management page URL in the Peach CRM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerDateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's date of birth, formatted like YYYY/MM/DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerFirstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's ID—starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerLastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerMaidenLastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's maiden name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerMiddleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's middle name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerPortalUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's loan portal page URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerPreferredFirstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The associated borrower's preferred first name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerPrimaryAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The primary address for the associated borrower."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections Related"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectionsAmountOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The total amount overdue for the active collections case, or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blank if there is no active case. (This is the same value as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmounts.overdue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field of the active collections case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectionsCaseCrmUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A URL to the active collection case in the Peach CRM for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated borrower; or blank if there is no active case."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consentsToAutodialedColl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutodialedColl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" consent. This consent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifies if the associated borrower has consented to received autodialed collection"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calls. If consent has been granted this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"consented\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"revoked\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". (If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there was an error fetching this information this field could be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"error\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".) See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/tags/Consent"},"href":"/tags/Consent"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on consents."},"children":[]}]}]}]}],"type":"string"},"outputName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the column to use in exported CSV file. If not specified, then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"},"type":"array"},"contactMatchingCriteria":{"description":"Settings for selecting a person's contact information to include in export data. An empty attribute\nis not allowed. Multiple attributes act as \"AND\" filters. E.g., a contact must\nhave an affiliation of \"self\" AND a label of \"home\" in order to match. If multiple\nvalues are specified for an attribute, the values act as \"OR\" conditions within that attribute.\n","properties":{"affiliation":{"description":"Array of person's contact affiliations. If multiple values are provided, values act as OR condition.\n","items":{"enum":["self","spouse","parent","guardian","executer","administrator","otherRelative","legal","businessOwner","businessExecutive","businessEmployee"],"type":"string"},"type":"array"},"contactType":{"description":"Array of person's contact types. Currently only \"Phone\" is supported.\n","items":{"enum":["phone"],"type":"string"},"type":"array"},"label":{"description":"Array of person's contact labels. If multiple values are provided, values act as OR condition.\n","items":{"enum":["personal","home","work","military"],"type":"string"},"type":"array"},"status":{"description":"Array of person's contact statuses. The values of this enumeration are used for getting the contact\nwith the highest priority. Items with lower number have higher priority. If multiple values are\nprovided, values act as OR condition.\n","items":{"enum":["primary","secondary","additional","archived"],"type":"string"},"type":"array"}},"type":"object"}},"type":"object"}},"components/schemas/BorrowerCampaign":{"id":"components/schemas/BorrowerCampaign","kind":"json-schema","title":"BorrowerCampaign","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower campaign is part of a system for exporting contact information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for borrowers or sending communications to borrowers in bulk."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower campaign objects represents this campaign. It contains the information specifying from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where a campaign derives its input borrower list, a schedule for execution, and the format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for exporting that list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The input borrowers list is defined by a Redash query. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redashQueryUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"properties":{"bulkSenderId":{"description":"The ID of an existing bulk sender to use for this campaign.\n","nullable":true,"type":"string"},"contactExporterId":{"description":"The ID of an existing contact exporter to use for this campaign.\n","nullable":true,"type":"string"},"redashApiKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key to use for querying Redash."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find your API key at https://{YOUR_REDASH_DOMAIN}/users/me."},"children":[]}]}]}],"nullable":true,"type":"string"},"redashQueryUrl":{"anyOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the Redash query from which to build the input."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL should look like https://{YOUR_REDASH_DOMAIN}/queries/{QUERY_ID}."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The output of this query is fed into the campaign system as input for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each new campaign run. (Note that the query is re-run on each campaign run.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query must produce a query result with at least the column "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g.:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId\n4,\n5,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId\n4,\n5,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a detailed description of how to format your query result see other options"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redashQueryUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"example":"https://acme-rd.peach.finance/queries/48","maxLength":150,"nullable":true,"title":"General","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The campaign bulk sender takes a Redash query result and maps"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each row to a call to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#peach.communicator.handlers.handle_send"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passing Custom Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To pass data to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint, you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context.<...>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefixed fields in the query result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A query result which looks like this:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,context.animal,context.utensil\n100,bear,spoon\n103,beaver,fork\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,context.animal,context.utensil\n100,bear,spoon\n103,beaver,fork\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"...will end up in requests to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communicator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"borrowerId\": \"BO-XXXX-XXXX\", // 100\n  \"context\": {\n    \"animal\": \"bear\",\n    \"utensil\": \"spoon\"\n  }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"borrowerId\": \"BO-XXXX-XXXX\", // 100\n  \"context\": {\n    \"animal\": \"bear\",\n    \"utensil\": \"spoon\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"borrowerId\": \"BO-YYYY-YYYY\",  // 103\n  \"context\": {\n    \"animal\": \"beaver\",\n    \"utensil\": \"fork\"\n  }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"borrowerId\": \"BO-YYYY-YYYY\",  // 103\n  \"context\": {\n    \"animal\": \"beaver\",\n    \"utensil\": \"fork\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certain preconfigured interaction subjects will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically have their contexts populated if they are provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the appropriate input data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For instance, a bulk sender with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnableReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subject will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically have these variables calculated and passed as context to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communicator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on an individual interaction subject's requirements see the other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"options for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redashQueryUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDueDateReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages are intended to remind a borrower they have a payment due."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId,loanPeriodId,\n100,200,300,\n103,205,305,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId,loanPeriodId,\n100,200,300,\n103,205,305,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilledAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remainingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may select any borrower-loan and loan period. You MUST only select"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan periods in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Minimal sanity-checking is performed on which borrower-loan and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan periods are selected. If you select invalid values, e.g., a loan period ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the past, then a message may still be sent."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: paymentDueDateReminder","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOverdue{Nth}Notice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages are intended to remind a borrower of overdue loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daysOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST select borrower-loans which are in an overdue state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Minimal sanity-checking is performed on which borrower-loan you are targeting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you select an invalid borrower-loan, e.g., a loan that is not overdue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then a message may still be sent."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: loanOverdueNthNotice","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages are intended to remind borrowers of upcoming payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduled via the autopay system."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilledAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remainingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans. For performance reasons you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should try to target loans which have autopay enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled for the given borrower-loan combination specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the query results row, then a message is sent if and only if there is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an upcoming scheduled payment configured. A message is only sent for the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upcoming scheduled payment. The message will send regardless of how far in the future"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the next upcoming payment date is."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Minimal sanity-checking is performed on which borrower-loan you are targeting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you select an invalid borrower-loan, e.g., a loan paid in full, a message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may still be sent."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: autopayPaymentReminder","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loginFirstPaymentReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages are intended to remind borrowers of their first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upcoming payment if they have not yet logged into the borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No context variables are automatically calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Minimal sanity-checking is performed on which borrower-loan you are targeting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you select an invalid borrower-loan, e.g., a loan with payments already made, a message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may still be sent."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: loginFirstPaymentReminder","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnableReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages remind borrowers to enable autopay."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No context variables are automatically calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No sanity-checking is performed on which borrower-loan you are targeting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you select a borrower that has already enabled autopay, they will still receive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a message here."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: autopayEnableReminder","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayAmountChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages inform borrowers that the amount of their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" autopayment has increased."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extraCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans will be skipped if they do not have an upcoming autopay or it is detected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extraCharge == 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: autopayAmountChanged","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"futurepayPaymentDueReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages inform borrowers that there is an upcoming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future payment scheduled. (Note that \"autopay\" is a separate concept from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduled future payment. e.g., a borrower can schedule a single future payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of enabling autopay.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like (targetPaymentDate is optional):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId,targetPaymentDate\n100,200,2023-01-01,\n103,205,,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId,targetPaymentDate\n100,200,2023-01-01,\n103,205,,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetPaymentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional and if it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not included"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the message will be sent for only the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upcoming scheduled payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans will be skipped if they do not have an scheduled future payment."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: futurepayPaymentDueReminder","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages inform borrowers that their loan is overdue and they need to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"take action to prevent charge-off."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId\n100,200,\n103,205,\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOffDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daysOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daysToChargeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans will be skipped if it is not overdue. Loans will be skipped if they are already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: loanRightToCurePersonalUnsecured","type":"string"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a campaign with a bulk sender subject of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardExpiresReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages inform borrowers that their payment card will expire."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Result Formatting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Redash query results should look like (lastFour is optional):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"borrowerId,loanId,lastFour\n100,200,1234\n103,205,5678\n...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"borrowerId,loanId,lastFour\n100,200,1234\n103,205,5678\n...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it is valid to use either public IDs (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BO-XXXX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or internal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database IDs (integers)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastFour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional column"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated Context Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following context variables are automatically calculated and passed to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/communcator/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MUST provide any target borrower-loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans will be skipped if there are no cards associated with the loan which are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiring "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the future"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If there are multiple cards associated with a loan expiring,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expiring card is selected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You MAY optionally provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastFour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column in your query results, in which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case a card's last four digits must match that, or the loan will be skipped."},"children":[]}]}]}],"maxLength":150,"nullable":true,"title":"bulkSender: cardExpiresReminder","type":"string"}]},"schedule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The schedule to run a campaign on, given in Peachy crontab time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specification format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peachy crontab is an extension to crontab(5) that adds a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time specification value 'P', which means \"Peach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decides\". Currently, the minute and hour fields must be 'P' (i.e.,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can not specify the time of the day), and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day-of-month, month, and day-of-week fields must NOT be 'P'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some examples of Peachy crontabs:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P P 1,15 * *"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Run on the 1st and 15th of every month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P P * * wed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Run every Wednesday"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P P * 10 *"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Run every day in October"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See https://crontab.guru/ for an expression builder."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the campaign does not run on a schedule (and therefore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be run manually)."},"children":[]}]}]}],"nullable":true,"type":"string"},"sftpSettings":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SFTP settings to be used to upload the results of a campaign run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At the completion of a campaign run, if these settings are specified, they"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are used to SFTP upload the files created as a result of the run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These files include the exporter contacts .csv file and the log file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file names for these files will be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{CAMPAIGN_ID}_{TIMESTAMP}_query_results.csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{CAMPAIGN_ID}_{EXPORTER_ID}_{TIMESTAMP}.csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{CAMPAIGN_ID}_{EXPORTER_ID}_{TIMESTAMP}.csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{CAMPAIGN_ID}_{EXPORTER_ID}_{TIMESTAMP}_log.txt"},"children":[]}]}]}]}],"nullable":true,"properties":{"cdDir":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The directory to change to (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on the server before performing the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file upload."},"children":[]}]}]}],"type":"string"},"host":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host of the SFTP server with which to connect."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be specified like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{hostname}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{hostname}:{port}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no port is specified the default SFTP port of 22 is assumed."},"children":[]}]}]}],"example":"sftp.acme.com:23","type":"string"},"password":{"description":"Note: the password field is encrypted-at-rest using the secure tokenizer.\n","type":"string"},"username":{"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/BorrowerCampaignFull":{"id":"components/schemas/BorrowerCampaignFull","kind":"json-schema","title":"BorrowerCampaignFull","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"$ref":"#/components/schemas/BorrowerCampaign"}]}},"components/schemas/BorrowerCampaignRunStatus":{"id":"components/schemas/BorrowerCampaignRunStatus","kind":"json-schema","title":"BorrowerCampaignRunStatus","data":{"description":"The status of a campaign run","enum":["failed","success","processing","initializing"],"type":"string"}},"components/schemas/BorrowerCampaignRun":{"id":"components/schemas/BorrowerCampaignRun","kind":"json-schema","title":"BorrowerCampaignRun","data":{"description":"A borrower campaign \"run\" is an object representing an execution of a campaign.\nIt contains metadata about the status of the execution of the run and the results\nof the run, which are generally exported contact lists and logs.\n","properties":{"availableFiles":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of files currently available for download via this campaign run's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".../download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"items":{"enum":["query_results.csv","campaign_input.json","contacts.csv","log.txt"],"type":"string"},"type":"array"},"borrowerCampaignId":{"description":"The ID of the borrower campaign to which this campaign run belongs.","type":"string"},"campaignInputFileId":{"type":"string","writeOnly":true},"contactsOutputFileId":{"type":"string","writeOnly":true},"logFileId":{"type":"string","writeOnly":true},"queryResultsFileId":{"type":"string","writeOnly":true},"status":{"$ref":"#/components/schemas/BorrowerCampaignRunStatus"}},"type":"object"}},"components/schemas/BaseCardIssuerPut":{"id":"components/schemas/BaseCardIssuerPut","kind":"json-schema","title":"BaseCardIssuerPut","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"issuerEventsSubscriber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines whether Peach or the lender will subscribe to the card issuer's events. This is usually decided based on which party will be involved in the authorization flow. Regardless of which option is selected, the lender should provide accountIdentifier information on the card object in order for Peach to be able to get information from the issuer required for servicing the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach will consume card issuer events in order to manage the card on behalf of the lender. Peach may provide the issuer information necessary to make approve/decline decisions as part of the auth flow, but the lender and issuer can still be entirely responsible for card authorization."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Lender will consume issuer events and make API calls to Peach to ensure balances remain in sync between issuer and servicer. Using this option, the lender and/or issuer are responsible for card authorization."},"children":[]}]}]}]}],"enum":["peach","lender"],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the card issuer is in the process of being configured and is not yet ready to be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the card issuer is ready to manage cards. Only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardIssuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment issuer was deprecated, and new cards cannot be managed."},"children":[]}]}]}],"enum":["draft","active","deprecated"],"type":"string"},"syncCardDetails":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will sync the card details from the card issuer automatically. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the lender will update the card details manually."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/MarqetaCardIssuer":{"id":"components/schemas/MarqetaCardIssuer","kind":"json-schema","title":"MarqetaCardIssuer","data":{"properties":{"cardIssuerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the card issuer/vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Marqeta API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Lithic API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Galileo API to manage cards."},"children":[]}]}]}],"enum":["marqeta"],"type":"string"},"marqetaAdminAccessToken":{"description":"The Marqeta admin access token.","type":"string","writeOnly":true},"marqetaApplicationToken":{"description":"The Marqeta application token.","type":"string","writeOnly":true},"marqetaJitFundingEnabled":{"default":false,"description":"If enabled, configures a JIT funding source on Marqeta and uses Peach for authorizations. Only applies to credit cards.","type":"boolean"},"marqetaJitFundingSourceToken":{"description":"The Marqeta JIT funding source token. Only applies to credit cards.","nullable":true,"readOnly":true,"type":"string"}},"required":["marqetaApplicationToken","marqetaAdminAccessToken"],"type":"object"}},"components/schemas/VirtualCardIssuerPut":{"id":"components/schemas/VirtualCardIssuerPut","kind":"json-schema","title":"VirtualCardIssuerPut","data":{"type":"object"}},"components/schemas/VirtualCardIssuer":{"id":"components/schemas/VirtualCardIssuer","kind":"json-schema","title":"VirtualCardIssuer","data":{"allOf":[{"$ref":"#/components/schemas/VirtualCardIssuerPut"},{"properties":{"cardType":{"description":"The type of card issued.\n","enum":["virtualCard"],"type":"string"}},"type":"object"}]}},"components/schemas/MarqetaVirtualCardIssuer":{"id":"components/schemas/MarqetaVirtualCardIssuer","kind":"json-schema","title":"Marqeta Virtual Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/MarqetaCardIssuer"},{"$ref":"#/components/schemas/VirtualCardIssuer"}],"title":"Marqeta Virtual Card"}},"components/schemas/UsageRestrictions":{"id":"components/schemas/UsageRestrictions","kind":"json-schema","title":"UsageRestrictions","data":{"properties":{"countries":{"description":"The list of countries where the card cannot be used. Any attempt to authorize the card for a\npurchase with a country in this list will be declined.\n","items":{"type":"string"},"type":"array"},"currencies":{"description":"The list of invalid currencies for card transactions. Any attempt to authorize the card for a\npurchase made in a currency in this list will be declined.\n","items":{"type":"string"},"type":"array"},"merchantCategoryCodes":{"description":"The list of merchant category codes to restrict. Any attempt to authorize the card for a purchase\nwith a merchant category code in the list will be declined.\n","items":{"type":"string"},"type":"array"},"merchantIds":{"description":"The list of specific merchant ID's where the card cannot be used. Any attempt to authorize\nthe card for a purchase with a merchant ID in the list will be declined.\n","items":{"type":"string"},"type":"array"},"merchantNamesRegex":{"description":"The list of merchant names where the card cannot be used. The format is a regular expression.\nPlease contact the Peach team to see examples of the merchant names.\nPeach will use matching logic using the regex value to decline transactions for merchants included in this list.\nLenders need to carefully assess this restriction because of the challenge in matching names in this\nlist to the merchant names provided during authorization.\n","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/CreditCardIssuerPut":{"id":"components/schemas/CreditCardIssuerPut","kind":"json-schema","title":"CreditCardIssuerPut","data":{"properties":{"program":{"properties":{"auth":{"properties":{"authLogic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authManagedBy = peach"},"children":[]}]}]}],"properties":{"authCustomFunctionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the authorization code referenced for executing auth logic. This is a custom function. Please coordinate with Peach before passing a value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authLogic = custom"},"children":[]}]}]}],"type":"string"},"authThresholdAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount over which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be exceeded. If provided, the system will approve a purchase that exceeds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" amount. Keep in mind that Draw can have a credit limit (it's optional as Line of Credit always has a credit limit). If a draw has a credit limit, this threshold will be also checked on the draw level. Keep empty/null if not applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit limit is $1000.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current utilization is $980.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is $20.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase of $33.00 will be approved. $980.00 + $33.00 < $1000.00 + $20.00."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can be provided."},"children":[]}]}]}],"type":"integer"},"authThresholdPercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage over which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be exceeded. If provided, the system will approve a purchase that exceeds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" percentage. Keep in mind that Draw can have a credit limit (it's optional as Line of Credit always has a credit limit). If a draw has a credit limit, this threshold will be also checked on the draw level. Keep empty/null if not applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is decimal. For example, 0.01 is 1% and 0.15 is 15%."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit limit is $1000.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current utilization is $980.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0.05 (aka 5.00%)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase of $33.00 will be approved. $980.00 + $33.00 < $1000.00 * (1 + 0.05)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authThresholdPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can be provided."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"authManagedBy":{"default":"lender","description":"Indicates who is responsible for purchase authorization logic.\n","enum":["lender","peach"],"type":"string"}},"type":"object"},"drawMappingEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables lenders to allow Peach to automatically associate purchases with specific draws based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"during draw creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMappingEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach is receiving card issuer events, and a draw is created with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawType=\"cashAdvance\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will automatically associate specific transaction types with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashAdvance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" draw based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on internal mapping logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMappingEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there is more than one draw on the card credit product, Peach's system will add"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the purchase to an arbitrarily chosen draw."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"usageRestrictions":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details on restrictions applied to the card product. Leaving the attributes blank indicates that the card can be used in any capacity. Including data for any of the attributes indicates that card usage should be restricted and NOT used in that capacity. E.g. currencies = USD means that purchases may NOT be made using USD currency."},"children":[]}]}]}]},{"$ref":"#/components/schemas/UsageRestrictions"}]}},"type":"object"}},"type":"object"}},"components/schemas/CreditCardIssuer":{"id":"components/schemas/CreditCardIssuer","kind":"json-schema","title":"CreditCardIssuer","data":{"allOf":[{"properties":{"cardType":{"description":"The type of card issued.\n","enum":["creditCard"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditCardIssuerPut"}]}},"components/schemas/MarqetaCreditCardIssuer":{"id":"components/schemas/MarqetaCreditCardIssuer","kind":"json-schema","title":"Marqeta Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/MarqetaCardIssuer"},{"$ref":"#/components/schemas/CreditCardIssuer"}],"title":"Marqeta Credit Card"}},"components/schemas/LithicCardIssuer":{"id":"components/schemas/LithicCardIssuer","kind":"json-schema","title":"LithicCardIssuer","data":{"properties":{"cardIssuerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the card issuer/vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Marqeta API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Lithic API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Galileo API to manage cards."},"children":[]}]}]}],"enum":["lithic"],"type":"string"},"lithicApiKey":{"description":"The Lithic API key.","type":"string","writeOnly":true},"lithicAsaWebhookSecret":{"description":"The Lithic ASA webhook secret.","type":"string","writeOnly":true},"lithicEventsWebhookSecret":{"description":"The Lithic events webhook secret.","type":"string","writeOnly":true}},"required":["lithicApiKey"],"type":"object"}},"components/schemas/LithicCreditCardIssuer":{"id":"components/schemas/LithicCreditCardIssuer","kind":"json-schema","title":"Lithic Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/LithicCardIssuer"},{"$ref":"#/components/schemas/CreditCardIssuer"}],"title":"Lithic Credit Card"}},"components/schemas/GalileoCardIssuer":{"id":"components/schemas/GalileoCardIssuer","kind":"json-schema","title":"GalileoCardIssuer","data":{"properties":{"cardIssuerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the card issuer/vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Marqeta API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Lithic API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Galileo API to manage cards."},"children":[]}]}]}],"enum":["galileo"],"type":"string"},"galileoApiLogin":{"description":"The Galileo API login.","type":"string","writeOnly":true},"galileoApiTransKey":{"description":"The Galileo API key.","type":"string","writeOnly":true},"galileoBaseUrl":{"description":"The Galileo base URL.","type":"string"},"galileoProviderId":{"description":"The Galileo provider ID.","type":"string"}},"required":["galileoApiLogin","galileoApiTransKey","galileoProviderId","galileoBaseUrl"],"type":"object"}},"components/schemas/GalileoVirtualCardIssuer":{"id":"components/schemas/GalileoVirtualCardIssuer","kind":"json-schema","title":"Galileo Virtual Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/GalileoCardIssuer"},{"$ref":"#/components/schemas/VirtualCardIssuer"}],"title":"Galileo Virtual Card"}},"components/schemas/GalileoCreditCardIssuer":{"id":"components/schemas/GalileoCreditCardIssuer","kind":"json-schema","title":"Galileo Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/GalileoCardIssuer"},{"$ref":"#/components/schemas/CreditCardIssuer"}],"title":"Galileo Credit Card"}},"components/schemas/QoloCardIssuer":{"id":"components/schemas/QoloCardIssuer","kind":"json-schema","title":"QoloCardIssuer","data":{"properties":{"cardIssuerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the card issuer/vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Marqeta API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Lithic API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Galileo API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qolo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Qolo API to manage cards."},"children":[]}]}]}],"enum":["qolo"],"type":"string"},"qoloApiKey":{"description":"The Qolo API Key.","type":"string","writeOnly":true},"qoloLoginId":{"description":"The Qolo login ID.","type":"string","writeOnly":true}},"required":["qoloLoginId","qoloApiKey"],"type":"object"}},"components/schemas/QoloCreditCardIssuer":{"id":"components/schemas/QoloCreditCardIssuer","kind":"json-schema","title":"Qolo Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/QoloCardIssuer"},{"$ref":"#/components/schemas/CreditCardIssuer"}],"title":"Qolo Credit Card"}},"components/schemas/CardIssuer":{"id":"components/schemas/CardIssuer","kind":"json-schema","title":"CardIssuer","data":{"anyOf":[{"$ref":"#/components/schemas/MarqetaVirtualCardIssuer"},{"$ref":"#/components/schemas/MarqetaCreditCardIssuer"},{"$ref":"#/components/schemas/LithicCreditCardIssuer"},{"$ref":"#/components/schemas/GalileoVirtualCardIssuer"},{"$ref":"#/components/schemas/GalileoCreditCardIssuer"},{"$ref":"#/components/schemas/QoloCreditCardIssuer"}]}},"components/schemas/MarqetaCardIssuerPut":{"id":"components/schemas/MarqetaCardIssuerPut","kind":"json-schema","title":"MarqetaCardIssuerPut","data":{"properties":{"cardIssuerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the card issuer/vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqeta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Marqeta API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Lithic API to manage cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will use the Galileo API to manage cards."},"children":[]}]}]}],"enum":["marqeta"],"readOnly":true,"type":"string"},"marqetaApplicationToken":{"description":"The Marqeta application token.","type":"string","writeOnly":true},"marqetaJitFundingEnabled":{"default":false,"description":"If enabled, configures a JIT funding source on Marqeta and uses Peach for authorizations.","type":"boolean"}},"type":"object"}},"components/schemas/MarqetaVirtualCardIssuerPut":{"id":"components/schemas/MarqetaVirtualCardIssuerPut","kind":"json-schema","title":"Marqeta Virtual Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/MarqetaCardIssuerPut"},{"$ref":"#/components/schemas/VirtualCardIssuerPut"}],"title":"Marqeta Virtual Card"}},"components/schemas/MarqetaCreditCardIssuerPut":{"id":"components/schemas/MarqetaCreditCardIssuerPut","kind":"json-schema","title":"Marqeta Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/MarqetaCardIssuerPut"},{"$ref":"#/components/schemas/CreditCardIssuerPut"}],"title":"Marqeta Credit Card"}},"components/schemas/LithicCardIssuerPut":{"id":"components/schemas/LithicCardIssuerPut","kind":"json-schema","title":"LithicCardIssuerPut","data":{"properties":{"lithicApiKey":{"description":"The Lithic API key.","type":"string","writeOnly":true},"lithicAsaWebhookSecret":{"description":"The Lithic ASA webhook secret.","type":"string","writeOnly":true},"lithicEventsWebhookSecret":{"description":"The Lithic events webhook secret.","type":"string","writeOnly":true}},"type":"object"}},"components/schemas/LithicCreditCardIssuerPut":{"id":"components/schemas/LithicCreditCardIssuerPut","kind":"json-schema","title":"Lithic Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/LithicCardIssuerPut"},{"$ref":"#/components/schemas/CreditCardIssuerPut"}],"title":"Lithic Credit Card"}},"components/schemas/GalileoCardIssuerPut":{"id":"components/schemas/GalileoCardIssuerPut","kind":"json-schema","title":"GalileoCardIssuerPut","data":{"properties":{"galileoApiLogin":{"description":"The Galileo API login.","type":"string","writeOnly":true},"galileoApiTransKey":{"description":"The Galileo API key.","type":"string","writeOnly":true},"galileoBaseUrl":{"description":"The Galileo base URL.","type":"string"},"galileoProviderId":{"description":"The Galileo provider ID.","type":"string"}},"type":"object"}},"components/schemas/GalileoVirtualCardIssuerPut":{"id":"components/schemas/GalileoVirtualCardIssuerPut","kind":"json-schema","title":"Galileo Virtual Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/GalileoCardIssuerPut"},{"$ref":"#/components/schemas/VirtualCardIssuerPut"}],"title":"Galileo Virtual Card"}},"components/schemas/GalileoCreditCardIssuerPut":{"id":"components/schemas/GalileoCreditCardIssuerPut","kind":"json-schema","title":"Galileo Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/GalileoCardIssuerPut"},{"$ref":"#/components/schemas/CreditCardIssuerPut"}],"title":"Galileo Credit Card"}},"components/schemas/QoloCardIssuerPut":{"id":"components/schemas/QoloCardIssuerPut","kind":"json-schema","title":"QoloCardIssuerPut","data":{"properties":{"qoloApiKey":{"description":"The Qolo API Key.","type":"string","writeOnly":true},"qoloLoginId":{"description":"The Qolo login ID.","type":"string","writeOnly":true}},"type":"object"}},"components/schemas/QoloCreditCardIssuerPut":{"id":"components/schemas/QoloCreditCardIssuerPut","kind":"json-schema","title":"Qolo Credit Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardIssuerPut"},{"$ref":"#/components/schemas/QoloCardIssuerPut"},{"$ref":"#/components/schemas/CreditCardIssuerPut"}],"title":"Qolo Credit Card"}},"components/schemas/CardIssuerPut":{"id":"components/schemas/CardIssuerPut","kind":"json-schema","title":"CardIssuerPut","data":{"anyOf":[{"$ref":"#/components/schemas/MarqetaVirtualCardIssuerPut"},{"$ref":"#/components/schemas/MarqetaCreditCardIssuerPut"},{"$ref":"#/components/schemas/LithicCreditCardIssuerPut"},{"$ref":"#/components/schemas/GalileoVirtualCardIssuerPut"},{"$ref":"#/components/schemas/GalileoCreditCardIssuerPut"},{"$ref":"#/components/schemas/QoloCreditCardIssuerPut"}]}},"components/schemas/VersionedMixin":{"id":"components/schemas/VersionedMixin","kind":"json-schema","title":"VersionedMixin","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"companyId":{"description":"The company identifier of the type.\n","readOnly":true,"type":"string"},"createdBy":{"nullable":true,"readOnly":true,"type":"integer"},"deprecatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deprecatedBy":{"nullable":true,"readOnly":true,"type":"integer"},"deprecationMessage":{"maxLength":100,"nullable":true,"readOnly":true,"type":"string"},"derivedFromTypeId":{"default":"0","description":"The type identifier that this type was derived from.\n","readOnly":true,"type":"string"},"description":{"default":"","description":"The description for instances of that type. The description could be shown in UI.\n","maxLength":500,"type":"string"},"name":{"default":"","description":"The default name for instances of that type. The name could be shown in UI.\n","maxLength":50,"type":"string"},"publishedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"publishedBy":{"nullable":true,"readOnly":true,"type":"integer"},"status":{"default":"draft","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type status. A new type is normally created in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. After you finish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the type configurations and ready to create instances of that type, update the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also update an existing type. Each update will create a new version of the type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one version of the type can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We'll automatically change the previous version to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instances in-flight will continue to use the previous version(s)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New instances will be created using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}],"enum":["draft","active","deprecated"],"type":"string"},"version":{"default":1,"description":"The type version.\n","readOnly":true,"type":"integer"}},"type":"object"}]}},"components/schemas/CaseTypeAssociation":{"id":"components/schemas/CaseTypeAssociation","kind":"json-schema","title":"objectAssociation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Objects are related to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CaseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and may have an optional label."},"children":[]}]}]}],"properties":{"objectId":{"description":"Peach unique identifier for the associated object.","type":"integer"},"objectType":{"description":"Types of objects that can be associated with the case.","enum":["doNotInteractType","notificationType","loanType"],"type":"string"}},"title":"objectAssociation","type":"object"}},"components/schemas/DataType":{"id":"components/schemas/DataType","kind":"json-schema","title":"DataType","data":{"description":"The field type of data. Used for properly parsing the field value.","enum":["integer","real","string","boolean","dateTime"],"type":"string"}},"components/schemas/FieldName":{"id":"components/schemas/FieldName","kind":"json-schema","title":"FieldName","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the field as known in the API (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"}},"components/schemas/CustomFieldSchema":{"id":"components/schemas/CustomFieldSchema","kind":"json-schema","title":"customFieldSchema","data":{"properties":{"dataType":{"$ref":"#/components/schemas/DataType"},"default":{"anyOf":[{"nullable":true,"type":"number"},{"nullable":true,"type":"string"},{"nullable":true,"type":"boolean"}],"description":"The default value of the field."},"description":{"default":"","description":"A helpful description of what the field is and does. Displayed in UI.","maxLength":500,"type":"string"},"displayOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired order of the field appearance in UI. Use whole numbers. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be placed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"integer"},"displayPostfix":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A postfix to display after the field value. For example, a field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can have a postfix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100 USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"displayPrefix":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A prefix to display before the field value. For example, a field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can have a prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"fieldName":{"$ref":"#/components/schemas/FieldName"},"name":{"default":"","description":"Field name as displayed in UI.","maxLength":50,"type":"string"},"required":{"default":false,"description":"Indicates whether this field is required on a new case creation.","type":"boolean"},"validation":{"description":"Validation rules","properties":{"enum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of valid values. Applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType=string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":[1,10,100],"items":{"oneOf":[{"type":"string"},{"type":"number"}]},"type":"array"},"length":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the field if applicable. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be limited to 50 characters."},"children":[]}]}]}],"minimum":1,"nullable":true,"type":"integer"},"maxValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum value. Applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType=integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":100,"type":"number"},"minValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum value. Applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType=integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0,"type":"number"}},"type":"object"}},"required":["name","fieldName","dataType"],"title":"customFieldSchema","type":"object"}},"components/schemas/CaseType":{"id":"components/schemas/CaseType","kind":"json-schema","title":"caseType","data":{"allOf":[{"$ref":"#/components/schemas/VersionedMixin"},{"properties":{"associations":{"description":"Associated objects to the case.","items":{"$ref":"#/components/schemas/CaseTypeAssociation"},"readOnly":true,"type":"array"},"customFieldSchemas":{"description":"Array of custom fields definitions.\n","items":{"$ref":"#/components/schemas/CustomFieldSchema"},"nullable":true,"type":"array"},"loanTypeId":{"description":"The optional identifier of a loan type. This is useful when a\nlender has two or more financial products and need different case types per product.\n","type":"string"},"object":{"default":"caseType","enum":["caseType"],"readOnly":true,"type":"string"},"smartReviews":{"properties":{"config":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration fields for when to create reminder"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tasks. Varies per case-type. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/smart-reviews"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart Reviews"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in-depth documentation."},"children":[]}]}]}],"nullable":true,"type":"object"},"enable":{"description":"Enable or disable using these settings to create reminder tasks.\n","type":"boolean"}},"type":"object"},"workflowTypeId":{"description":"The optional identifier of a workflow type. Instances of the workflow\ntype are created for processing cases of this type.\n","type":"string"}},"type":"object"}],"title":"caseType"}},"components/schemas/BaseCaseType":{"id":"components/schemas/BaseCaseType","kind":"json-schema","title":"BaseCaseType","data":{"enum":["generic","bankruptcy","ceaseCommunication","collection","deceased","disputeOfDebt","federalEmergency","identityTheft","legalAction","militaryDuty","debtValidation","oFACSanctionedIndividual","disputeOfPurchase","creditBureauDispute"],"type":"string"}},"components/schemas/CaseTypePostOnly":{"id":"components/schemas/CaseTypePostOnly","kind":"json-schema","title":"caseType","data":{"allOf":[{"properties":{"caseType":{"$ref":"#/components/schemas/BaseCaseType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base case type for your case. If you choose any special type, except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type will inherit all the attributes of that special type."},"children":[]}]}]}]},"copyOf":{"description":"The ID of case type to copy and advance the version number\n","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/CaseType"}],"title":"caseType"}},"components/schemas/InteractionStatus":{"id":"components/schemas/InteractionStatus","kind":"json-schema","title":"InteractionStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of an interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is important, as it can impact future interactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For instance, in jurisdictions which cap the number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of outbound collection communications to a borrower,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions do not count against the legal allotment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated as the interaction status changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, when an email is sent, set the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attempted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the email is opened, set the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the email bounces,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attempted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed to be a successful"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction. Optionally, you can also use 'statusDetails' to provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional details about status."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-Progress interactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some interactions—like an email—take place at a single point in time, others"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"might be ongoing for many minutes—like a phone call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ongoing interactions like voice and chat may have their status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled interactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some interactions might be scheduled for the future. These interactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this scheduled interaction is unscheduled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then it has a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid status name but rather can be used to specify a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query for interactions with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"enum":["attempted","succeeded","failed","scheduled","canceled","inProgress","null"],"type":"string"}},"components/schemas/InteractionChannel":{"id":"components/schemas/InteractionChannel","kind":"json-schema","title":"InteractionChannel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel where interactions with a borrower occur. For example, an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outbound call with a borrower is considered a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" channel is deprecated: new interactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be created with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" channel. It will be removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from completely in the future."},"children":[]}]}]}],"enum":["voice","email","fax","text","chat","mail","gui","document"],"nullable":true,"type":"string"}},"components/schemas/ObjectAssociation":{"id":"components/schemas/ObjectAssociation","kind":"json-schema","title":"objectAssociation","data":{"description":"Objects are related to case.\n","properties":{"objectId":{"description":"Peach unique identifier for the associated object.","type":"string"},"objectType":{"description":"Types of objects that can be associated with the case.","enum":["document","interaction","loan","case","transaction"],"type":"string"}},"title":"objectAssociation","type":"object"}},"components/schemas/CaseAssociation":{"id":"components/schemas/CaseAssociation","kind":"json-schema","title":"caseAssociation","data":{"allOf":[{"$ref":"#/components/schemas/ObjectAssociation"},{"properties":{"relation":{"default":"related","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectType=case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to read the relation is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId=111"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseType=identityTheft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId=222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseType=debtValidation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity theft case is blocking verification of debt. To represent that relation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId=111"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation=blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectId=222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in body."},"children":[]}]}]}]}],"enum":["related","causes","blocks","duplicate"],"type":"string"}},"type":"object"}],"description":"Objects are related to case, and may have an optional label.\n","title":"caseAssociation"}},"components/schemas/CaseConfigType":{"id":"components/schemas/CaseConfigType","kind":"json-schema","title":"caseConfigType","data":{"description":"Summary information about the case type configuration which produced the case.\n","properties":{"base":{"type":"string"},"derivedFromTypeId":{"nullable":true,"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"version":{"type":"integer"}},"readOnly":true,"title":"caseConfigType","type":"object"}},"components/schemas/UserActionInfo":{"id":"components/schemas/UserActionInfo","kind":"json-schema","title":"UserActionInfo","data":{"nullable":true,"properties":{"descriptor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short description of the user who performed the action."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different systems may have different data available for a given user. The descriptor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gives the best available short description of the user. It prefers names, then email addresses,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then related IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g.,"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Borrower Tim Jones\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Borrower BO-ABCD-1234\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Peach Service User\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Agent Abigail Smith\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Agent bob@acme.com\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Agent EM-ABCD-1234\""},"children":[]}]}]}]}],"example":"Agent bob@acme.com","nullable":true,"type":"string"},"employee":{"nullable":true,"properties":{"id":{"description":"The employee's ID","type":"string"}},"type":"object"},"id":{"description":"The unique identifier of the user who performed the action.","type":"string"},"name":{"description":"The name of the user who performed the action.","nullable":true,"type":"string"},"userType":{"$ref":"#/components/schemas/UserType"}},"readOnly":true,"type":"object"}},"components/schemas/CaseCreationProcedure":{"id":"components/schemas/CaseCreationProcedure","kind":"json-schema","title":"CaseCreationProcedure","data":{"description":"The field indicating which procedure originally created this case.\n\nThis is used to mark when a system like, for instance, Compliance Guard \nautomatically created a case, which allows a case to be \ndifferentiated from, for instance, manually created ones.\n","enum":["automatedCollectionsDetection","automatedOfacDetection","automatedBankruptcyDetection","automatedDeceasedDetection","automatedScraDetection","supercasePopulationCommit"],"nullable":true,"type":"string"}},"components/schemas/CustomFields":{"id":"components/schemas/CustomFields","kind":"json-schema","title":"customFields","data":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are JSON key-value mappings. They are described by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldSchemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property in the corresponding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This means that arbitrary fields cannot be added to in-flight cases."},"children":[]}]}]}],"nullable":true,"title":"customFields","type":"object"}},"components/schemas/MatchDetails":{"id":"components/schemas/MatchDetails","kind":"json-schema","title":"matchDetails","data":{"description":"The fields that are for what levels the person is matched to a monitoring hit (i.e. bankruptcy)\n","properties":{"addressMatch":{"enum":["match","partialMatch","noMatch","notApplicable"],"type":"string"},"dateOfBirthMatch":{"enum":["match","partialMatch","noMatch","notApplicable"],"type":"string"},"externalMatchCode":{"nullable":true,"type":"string"},"last4SSNMatch":{"enum":["match","partialMatch","noMatch","notApplicable"],"type":"string"},"matchDoneBy":{"enum":["dataVendor","peach"],"type":"string"},"nameMatch":{"enum":["match","partialMatch","noMatch","notApplicable"],"type":"string"},"ssnMatch":{"enum":["match","partialMatch","noMatch","notApplicable"],"type":"string"}},"title":"matchDetails","type":"object"}},"components/schemas/MetaData":{"id":"components/schemas/MetaData","kind":"json-schema","title":"MetaData","data":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"}},"components/schemas/ProcessOutcome":{"id":"components/schemas/ProcessOutcome","kind":"json-schema","title":"outcome","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The outcome of a process, case, complaint, or dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If found to be valid, set value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This might impact debt collection efforts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If dismissed, set value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"denied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will have no further impact on debt collection efforts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If found to be a false positive, set value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"falsePositive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If completed without an outcome (or no outcome was needed), set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["approved","denied","falsePositive","noOutcome"],"nullable":true,"title":"outcome","type":"string"}},"components/schemas/ProcessStatus":{"id":"components/schemas/ProcessStatus","kind":"json-schema","title":"status","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of a process. This can be updated by a lender or by Peach."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The lender was notified by a borrower, but no documents or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"evidence have been provided yet. A grace period can be set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach matched the borrower to an external data source, or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lender started an internal process to handle a case, complaint or dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The lender completed an internal process, case, complaint or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower reported identity theft, and the lender reviewed documents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and approved the claim."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower requested a verification of debt in writing, and the lender sent an email with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach notified the lender about a new bankruptcy, and the lender reviewed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the case and deemed it to be a false positive."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The lender couldn't complete an internal process and canceled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it. This can happen for various reasons, such as lack of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sufficient documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reopened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The lender re-opened the case."},"children":[]}]}]}],"enum":["initiated","processing","completed","canceled","reopened"],"title":"status","type":"string"}},"components/schemas/CaseAttributes":{"id":"components/schemas/CaseAttributes","kind":"json-schema","title":"CaseAttributes","data":{"properties":{"associations":{"description":"Associated objects of the case.","items":{"anyOf":[{"$ref":"#/components/schemas/ObjectAssociation"},{"$ref":"#/components/schemas/CaseAssociation"}]},"nullable":true,"type":"array"},"autoCreated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True if the case was created by some automated method—i.e., not by a human."},"children":[]}]}]}],"type":"boolean"},"borrowerIds":{"description":"List of borrower IDs associated with case","items":{"type":"string"},"type":"array"},"caseTypeMeta":{"$ref":"#/components/schemas/CaseConfigType"},"companyId":{"description":"The company's ID","readOnly":true,"type":"string"},"createReviewTask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" create a task of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewAutoCreatedCase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note: this field is NOT saved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the case resource; it just creates a task."},"children":[]}]}]}],"type":"boolean","writeOnly":true},"createdByUser":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the case.\nCan be an agent or automated system process.\n"},"creatingSupercaseId":{"description":"The ID of the supercase if the case was created by one.","nullable":true,"readOnly":true,"type":"string"},"creationProcedure":{"$ref":"#/components/schemas/CaseCreationProcedure"},"customFields":{"$ref":"#/components/schemas/CustomFields"},"escalatedAt":{"description":"Timestamp of when the case was escalated.\n","format":"date-time","nullable":true,"type":"string"},"escalatedEmployeeId":{"description":"The ID of the Employee to which the case should be escalated.","nullable":true,"type":"string"},"escalatedTeamId":{"description":"The ID of the Team to which the case should be escalated.","nullable":true,"type":"string"},"escalationIsUrgent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean representing if this escalation is urgent. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no escalation."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"externalId":{"$ref":"#/components/schemas/externalId"},"lastSubresourceUpdatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date-time at which the case or it's subresources were last updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case or case's subresources are considered updated when:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an attribute of a Case is changed directly—e.g., it's name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a Snooze, Do Not Interact, Document Upload Link, or Note is created, deleted or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an Interaction, Document, Loan, or Transaction is associated or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unassociated with the case."},"children":[]}]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"lastSubresourceUpdatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the user responsible for last updating a case or a case's subresources."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be an agent or automated system process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastSubresourceUpdatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a description of subresources."},"children":[]}]}]}]},"lastViewedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date-time at which the case was last viewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i.e., when this case last had this request made:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/people/{borrowerId}/cases/{caseId}/views"},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"lastViewedBy":{"$ref":"#/components/schemas/UserActionInfo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the user responsible for last viewing the case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i.e., the user which last made the request:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/people/{borrowerId}/cases/{caseId}/views"},"children":[]}]}]}]},"lenderAck":{"default":false,"description":"The lender has acknowledged the auto-generated case.\n","nullable":true,"type":"boolean"},"matchDetails":{"$ref":"#/components/schemas/MatchDetails"},"matchToDataSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the person's details have been matched to an external data source."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"metaData":{"$ref":"#/components/schemas/MetaData"},"name":{"description":"The case name. If a name is not provided, the case name is taken from the case type.\nFor example, Identity Theft.\n","maxLength":100,"minLength":1,"type":"string"},"object":{"default":"case","enum":["case"],"readOnly":true,"type":"string"},"openedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the original date-time a case was created, either within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach or in an external system. For cases created directly in Peach CRM, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marking the initiation within Peach. Conversely, for cases migrated from external sources, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the time the case was originally established in the external system. The timestamp must include a timezone (or UTC offset)."},"children":[]}]}]}],"format":"date-time","nullable":true,"type":"string"},"outcome":{"$ref":"#/components/schemas/ProcessOutcome"},"outcomeUpdatedAt":{"description":"Timestamp of last outcome update.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"outcomeUpdatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for last updating the case outcome.\nCan be an agent or automated system process.\n"},"owningEmployee":{"description":"Metadata about the owning employee of the case. The owning employee is the\npreferred employee to process tasks relating to this case.\n","nullable":true,"properties":{"displayName":{"description":"The display name of the employee that owns this case. The display name is the full name \nof the employee or, if not available, the employee's email.\n","readOnly":true,"type":"string"},"id":{"description":"The ID of the employee that owns this case.","readOnly":true,"type":"string"},"twilioWorkerSid":{"description":"The Twilio worker SID of the employee that owns this case.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"owningEmployeeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the employee that owns this case. The case owner is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preferred employee to process tasks relating to this case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case ownership must be enabled via setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tasks.enableCaseOwnership"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the company configuration."},"children":[]}]}]}],"nullable":true,"type":"string"},"people":{"description":"List of borrower IDs associated with case","items":{"type":"string"},"type":"array"},"snoozedAt":{"description":"Time when the case was snoozed.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"snoozedUntil":{"description":"Date until the case is snoozed.","format":"date","nullable":true,"readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/ProcessStatus"},"statusUpdatedAt":{"description":"Timestamp of the last status update.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"statusUpdatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for last updating the case status.\nCan be an agent or automated system process.\n"},"workflowId":{"description":"The ID of the workflow instance assigned to this case.","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/Bankruptcy":{"id":"components/schemas/Bankruptcy","kind":"json-schema","title":"bankruptcy","data":{"description":"Keyword parameters unique to bankruptcies.","properties":{"anticipatedCaseCompletionDate":{"description":"In a bankruptcy chapter that leverages a reorganization and a new\npayment plan (i.e. Chapter 13), record when the last payment is\nexpected to be received. This will trigger reminders to close out\nthe case.\n","format":"date","nullable":true,"type":"string"},"caseType":{"enum":["bankruptcy"],"type":"string"},"courtCaseChapter":{"description":"The bankruptcy chapter code. One of four common types we support at\nthis time.\n","enum":["chapter7","chapter11","chapter12","chapter13","unknown"],"type":"string"},"courtCaseClosedDate":{"description":"Date the bankruptcy case closed, and the case is no longer on the court docket.\n","format":"date","type":"string"},"courtCaseDebtorDisposition":{"description":"The outcome of the bankruptcy case decided by the court.\n","enum":["dismissed","discharged","reinstated"],"type":"string"},"courtCaseDebtorDispositionDate":{"description":"Date on which the disposition was decided by the court.\n","format":"date","type":"string"},"courtCaseFiledDate":{"description":"The bankruptcy court filing date. This is also when 'automatic stay'\nis invoked and creditors must stop calling borrowers or making\nattempts to collect on his or her debt.\n","format":"date","type":"string"},"courtCaseLastStatus":{"description":"The latest-reported bankruptcy case status, not case outcome, as it\nappears in the court.\n","enum":["filed","dismissed","discharged","conversion","reinstated","closedFiledInError","closedTransferredOut","closedDischargeNA","closedUndeterminedReason"],"type":"string"},"courtCaseLastStatusUpdatedDate":{"description":"Date on which the latest status of the bankruptcy case was updated.\n","format":"date","type":"string"},"courtCaseNumber":{"description":"The unique identifier the courts use during the filing and review of\nthe bankruptcy.\n","type":"string"},"creditorClaimDeadlineDate":{"description":"The date a lender has to file a claim to be eligible for any bankruptcy proceeds.\n","format":"date","nullable":true,"type":"string"},"listedOutstandingDebt":{"description":"When a bankruptcy is filed, the borrower lists all the creditors/loans\nhe/she knows to be outstanding. Sometimes he/she may forget to list\na loan/creditor, in which case the creditor may want to file a claim\nto ensure that the loan is added to the list of accounts to include\nin the bankruptcy.\n","type":"boolean"}},"title":"bankruptcy","type":"object"}},"components/schemas/CeaseCommunication":{"id":"components/schemas/CeaseCommunication","kind":"json-schema","title":"ceaseCommunication","data":{"properties":{"caseType":{"enum":["ceaseCommunication"],"type":"string"},"interactionId":{"description":"ID for the interaction that resulted in the case being opened","type":"integer"},"noticeReceivedDate":{"description":"The written notification date, or oral notice as mandated by each state, of the cease communications. This is when the legal timeline begins.\n","format":"date","type":"string"}},"title":"ceaseCommunication","type":"object"}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"description":"Name of the person.","nullable":true,"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"current":{"default":true,"description":"Name is flagged as current.","readOnly":true,"type":"boolean"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"effectiveAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"firstName":{"description":"A person's first name.","maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"string"},"lastName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"maxLength":50,"type":"string"},"maidenLastName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's maiden name, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"J."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"nullable":true,"type":"string"},"middleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's middle name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"maxLength":50,"nullable":true,"type":"string"},"object":{"default":"name","enum":["name"],"readOnly":true,"type":"string"},"originalValue":{"description":"The original value for name before an update.","readOnly":true,"type":"object"},"preferredFirstName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's preferred first name. This name will be used for interactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"like emails, text messages, outbound calls, online portal, etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no preferred name is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"nullable":true,"type":"string"},"prefix":{"description":"A person's name prefix.","nullable":true,"type":"string"},"source":{"enum":["peach","lender","externalAPI"],"readOnly":true,"type":"string"},"status":{"enum":["active","inactive"],"readOnly":true,"type":"string"},"suffix":{"description":"A person's name suffix.","maxLength":5,"nullable":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"required":["firstName","lastName"],"type":"object"}},"components/schemas/RedactedFields":{"id":"components/schemas/RedactedFields","kind":"json-schema","title":"RedactedFields","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paths of fields on this object whose values were hidden because your credentials lack the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. Always present on responses that can carry personal data — an empty array means nothing was hidden. Paths are relative to this object. Objects nested inside this one, including every element of an array of objects, carry their own list rather than appearing here. A path ending in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an array of plain values such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selfEmails[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and means at least one element of that array was hidden — not necessarily all of them. This field is never accepted on requests."},"children":[]}]}]}],"example":["name.lastName","dateOfBirth"],"items":{"type":"string"},"readOnly":true,"type":"array"}},"components/schemas/ContactAffiliation":{"id":"components/schemas/ContactAffiliation","kind":"json-schema","title":"ContactAffiliation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All contacts are associated with one borrower. Sometimes the contact represents information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about the borrower person themselves—e.g., the borrower's address. Sometimes the contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"represents information about a person affiliated with the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - denotes contact information about the borrower. All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contacts are considered to be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first-party"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spouse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guardian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"administrator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherRelative"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"considered to be a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Some regulations define these to be the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka the person)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for purposes of debt collection efforts. This means that a debt collector may communicate about the debt"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the consumer's spouse, parent (if the consumer is a minor), guardian,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executor, or administrator (or with the attorney of any of these people)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated text messages (e.g. payment reminder) can only be sent to contactType="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and affiliation="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["self","spouse","parent","guardian","executor","administrator","otherRelative","legal","businessOwner","businessExecutive","businessEmployee"],"type":"string"}},"components/schemas/ContactType":{"id":"components/schemas/ContactType","kind":"json-schema","title":"ContactType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsApp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be provided in "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be provided in "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aaa@bbb.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the mailing address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fbMessenger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be phone or email."},"children":[]}]}]}],"enum":["phone","email","address","whatsApp","fbMessenger"],"type":"string"}},"components/schemas/ContactLabel":{"id":"components/schemas/ContactLabel","kind":"json-schema","title":"ContactLabel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact label."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's mobile phone should be labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's home address should be labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A servicemember's military unit or commander contact should be labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"military"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated text messages (e.g. payment reminder) can only be sent to contactType="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and affiliation="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["personal","home","work","military"],"type":"string"}},"components/schemas/ContactStatus":{"id":"components/schemas/ContactStatus","kind":"json-schema","title":"ContactStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the contact status as primary, secondary, additional or archived."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Within a set of contacts with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affilation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contacts are allowed. There may"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a new contact is created as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there is an existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affilation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the status of the existing contact will be automatically changed to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a new contact is created as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there is an existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affilation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the status of the existing contact will be automatically changed to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["primary","secondary","additional","archived"],"type":"string"}},"components/schemas/ContactInformationInternal":{"id":"components/schemas/ContactInformationInternal","kind":"json-schema","title":"contactInformation","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact details. A contact can be email, phone, address,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"etc. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is optional, and is useful for third-party contacts such as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spouse, attorney, etc."},"children":[]}]}]}],"properties":{"address":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission the street-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POBox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city, state, postal code, and country are retained."},"children":[]}]}]}],"nullable":true},"affiliation":{"$ref":"#/components/schemas/ContactAffiliation"},"authorizedThirdParty":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signifies an individual authorized by the borrower to make purchases and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changes against the account that is the subject of the collection efforts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is not applicable to contacts with affiliation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"companyId":{"description":"The unique company identifier.","readOnly":true,"type":"string"},"contactType":{"$ref":"#/components/schemas/ContactType"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for an object. After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"label":{"$ref":"#/components/schemas/ContactLabel"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name of a third-party contact. Only applicable for third-party contacts, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spouse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]}],"maxLength":50,"minLength":0,"nullable":true,"type":"string"},"object":{"default":"contact","enum":["contact"],"readOnly":true,"type":"string"},"personId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the borrower to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}],"readOnly":true,"type":"string"},"phoneDisconnectionDetails":{"properties":{"disconnectionStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The disconnect status of a check that was performed on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastDisconnectCheckDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the value is empty, the disconnect check was not performed on the number. Applicable only to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType=phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the number is contained in the Reassigned Numbers Database (RND) and it has been disconnected since the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastKnownConnectionDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the number is contained in the Reassigned Numbers Database, and it has NOT been disconnected since the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastKnownConnectionDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the number and a permanent disconnect date are not contained in the Reassigned Numbers Database. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the rules related to outbound communications."},"children":[]}]}]}],"enum":["disconnected","connected","noData"],"nullable":true,"type":"string"},"lastDisconnectCheckDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the system performed a disconnect check against the Reassigned Numbers Database."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is empty, the disconnect check was not performed on the number. Applicable only to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType=phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"lastKnownConnectionDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date obtained by the borrower to contact them or a past date in which the lender is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasonably certain that the borrower could still be reached at that number. When contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is created the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastKnownConnectionDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt::date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This date is used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to monitor the disconnect status in the Reassigned Numbers Database (RND)."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"}},"type":"object"},"powerOfAttorney":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designated an individual with power of attorney. This attribute can only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be set by agents upon receiving appropriate documents from the borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or their attorney. This attribute is not applicable to contacts with affiliation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"receiveTextMessages":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows using a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type contact for text messaging."},"children":[]}]}]}],"type":"boolean"},"receiveTextMessagesLastConsentAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiveTextMessages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" consent was obtained (aka set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/ContactStatus"},"valid":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a contact as valid or invalid. A contact can become invalid for multiple reasons, such as wrong format,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid email domain, etc. This attribute can be changed by you or by Peach. If no value is provided, we will assume valid="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a contact. This attribute should be used for all contact types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"except for address, which has dedicated attributes such as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressCity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc. You should use either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes depending on the contact type. For example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+14155552671"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a contact type="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Or, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"john.smith@domain.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a contact type="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We'll validate the format based on the contact type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission this value is redacted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsApp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are masked to the last four"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"digits (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"********1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is masked (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"j***@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and all other types are returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"verified":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a contact as verified or unverified. Contact can be verified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via a verification code, verification link or a first-party outbound call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value can be changed by you or by Peach. If no value is provided, we"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will assume verified="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}],"title":"contactInformation"}},"components/schemas/ContactInformation":{"id":"components/schemas/ContactInformation","kind":"json-schema","title":"contactInformation","data":{"allOf":[{"$ref":"#/components/schemas/ContactInformationInternal"},{"properties":{"phoneDisconnectionDetails":{"properties":{"disconnectionStatus":{"readOnly":true},"lastDisconnectCheckDate":{"readOnly":true}},"type":"object"},"redactedFields":{"$ref":"#/components/schemas/RedactedFields"}},"type":"object"}],"title":"contactInformation"}},"components/schemas/Deceased":{"id":"components/schemas/Deceased","kind":"json-schema","title":"deceased","data":{"description":"Object describing a deceased borrower case","properties":{"caseType":{"enum":["deceased"],"type":"string"},"dateOfBirth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of birth as reported by the data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"dateOfDeath":{"description":"The date of death as reported by the data source.","format":"date","type":"string"},"dateOfDeathByAgent":{"description":"The date of death as recorded by the agent.","format":"date","nullable":true,"type":"string"},"deceasedAddress":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address as reported by the data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission the street-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POBox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city, state, postal code, and country are retained."},"children":[]}]}]}]},"deceasedName":{"$ref":"#/components/schemas/Name","description":"The name as reported by the data source."},"deceasedNoticeReceivedDate":{"description":"The date we became aware of the consumer's death. This is not the date of death.\nThis notice is received from our internal system.\n","format":"date","nullable":true,"type":"string"},"deceasedNoticeReceivedDateByAgent":{"description":"The date you became aware of the consumer's death. This is not the date of death.\n","format":"date","nullable":true,"type":"string"},"exactDateOfDeathUnknown":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, the exact date of death is unknown. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exactDateOfDeathUnknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfDeath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only accurate to the month and year specified."},"children":[]}]}]}],"type":"boolean"},"redactedFields":{"$ref":"#/components/schemas/RedactedFields"},"representativeOfEstateContact":{"$ref":"#/components/schemas/ContactInformation","description":"Contact details of the legal representative.","readOnly":true},"representativeOfEstateContactId":{"description":"Decedent account holder's contact ID. It can be a legal representative,\nor an appointed representative by the deceased.\n","nullable":true,"type":"string"}},"title":"deceased","type":"object"}},"components/schemas/DisputeOfDebt":{"id":"components/schemas/DisputeOfDebt","kind":"json-schema","title":"disputeOfDebt","data":{"properties":{"caseType":{"enum":["disputeOfDebt"],"type":"string"},"disputeConfirmedReason":{"description":"The dispute confirmed reason is only used when a case is confirmed as disputed.","enum":["APR","outstandingBalance","monthlyBalance","incorrectAtCreditBureau","other"],"type":"string"},"disputeNotice":{"description":"ID for the interaction that resulted in the dispute case being opened","nullable":true,"type":"string"},"noticeReceivedDate":{"description":"The first time a Direct Dispute Notice was received from the borrower.\nThis is when the legal timeline begins.\n","format":"date","type":"string"},"reasonForDispute":{"description":"The reason for the dispute of debt.\n","enum":["inaccurateOrIncompleteDetails","loanAlreadyPaidInFull","missingCreditedPayments","fundsNeverReceived","coercedDebt","other"],"type":"string"},"scopeOfDispute":{"description":"Scope of the dispute.","enum":["entireLoan","remainingLoanAmount","interestRate","fees","otherTerms"],"type":"string"}},"title":"disputeOfDebt","type":"object"}},"components/schemas/FederalEmergencyDisaster":{"id":"components/schemas/FederalEmergencyDisaster","kind":"json-schema","title":"FederalEmergencyDisaster","data":{"properties":{"declarationDate":{"description":"Date the disaster was declared.\n","format":"date-time","type":"string"},"declaredCountyArea":{"description":"The name or phrase describing the U.S. county that was\nincluded in the declaration.\n","maxLength":50,"type":"string"},"disasterCloseOutDate":{"description":"Date all financial transactions for all programs are completed.\n","format":"date-time","nullable":true,"type":"string"},"disasterNumber":{"description":"Sequentially assigned number used to designate an event or incident\ndeclared as a disaster. For more information on the disaster\nprocess, www.fema.gov.\n","type":"integer"},"disasterType":{"description":"Two character code that defines if the disaster is a Major Disaster\nDeclaration (DR), Emergency Declaration (EM), Fire Management\nAssistance Declaration (FM), or Fire Suppression Authorization (FS).\nFor more information on the disaster process,\nplease visit: www.fema.gov.\n","maxLength":2,"minLength":2,"type":"string"},"femaId":{"maxLength":25,"type":"string"},"fyDeclared":{"description":"The fiscal year the disaster was declared.\n","type":"integer"},"hmProgramDeclared":{"description":"Denotes whether the Hazard Mitigation program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"iaProgramDeclared":{"description":"Denotes whether the Individual Assistance program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"ihProgramDeclared":{"description":"Denotes whether the Individuals and Households program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"incidentBeginDate":{"description":"Date the incident itself began.\n","format":"date-time","type":"string"},"incidentEndDate":{"description":"Date the incident itself ended.\n","format":"date-time","nullable":true,"type":"string"},"incidentType":{"description":"Type of incident such as fire or flood. The incident type will\naffect the types of assistance available. For more information on\nincident types, please visit: www.fema.gov.\n","maxLength":100,"type":"string"},"lastRefresh":{"description":"Date the record was last updated in the FEMA API data store.\n","format":"date-time","type":"string"},"paProgramDeclared":{"description":"Denotes whether the Public Assistance program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"placeCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code system FEMA uses internally to recognize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locations that takes the numbers \"99\" + the 3-digit county"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FIPS code. There are some declared locations that don't have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognized FIPS county codes in which case we assigned a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unique identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We map person's home zip code to FIPS code."},"children":[]}]}]}],"type":"string"},"stateCode":{"description":"The name or phrase describing the U.S. state, district, or territory.\n","maxLength":2,"minLength":2,"type":"string"}},"type":"object"}},"components/schemas/FederalEmergency":{"id":"components/schemas/FederalEmergency","kind":"json-schema","title":"federalEmergency","data":{"properties":{"caseType":{"enum":["federalEmergency"],"type":"string"},"disaster":{"allOf":[{"$ref":"#/components/schemas/FederalEmergencyDisaster"},{"readOnly":true,"type":"object"}]},"disasterId":{"description":"ID of the FEMA disaster\n","type":"integer","writeOnly":true}},"title":"federalEmergency","type":"object"}},"components/schemas/GenericCase":{"id":"components/schemas/GenericCase","kind":"json-schema","title":"generic","data":{"properties":{"caseType":{"enum":["generic"],"type":"string"}},"title":"generic","type":"object"}},"components/schemas/IdentityTheft":{"id":"components/schemas/IdentityTheft","kind":"json-schema","title":"identityTheft","data":{"properties":{"caseType":{"enum":["identityTheft"],"type":"string"},"claimRejectedReason":{"description":"The rejected claim reason is only used when a case is deemed\n'not validated.' Only one reason is associated with a set of associated loans.\n","enum":["requestedInformationNotReceived","invalidDocumentation","insufficientDocumentation","householdResponsible","namedOnAccount","other"],"type":"string"},"reportReceivedDate":{"description":"The first time an identity theft report was received from the borrower.\nThis is when the legal timeline begins.\n","format":"date","type":"string"}},"title":"identityTheft","type":"object"}},"components/schemas/LegalAction":{"id":"components/schemas/LegalAction","kind":"json-schema","title":"legalAction","data":{"properties":{"caseType":{"enum":["legalAction"],"type":"string"},"legalActionInitiatedDate":{"description":"Date the legal action initiated","format":"date","type":"string"},"legalJudgmentEffectiveDate":{"description":"Legal judgment effective date","format":"date","type":"string"}},"title":"legalAction","type":"object"}},"components/schemas/MilitaryDuty":{"id":"components/schemas/MilitaryDuty","kind":"json-schema","title":"militaryDuty","data":{"description":"Object describing an active military duty case.","properties":{"caseType":{"enum":["militaryDuty"],"type":"string"},"claimingSCRArights":{"description":"The borrower is claiming SCRA rights and protections","nullable":true,"type":"boolean"},"dutyCertificateFile":{"description":"The unique identifier for the downloaded certificate file from monitoring service.","nullable":true,"type":"string"},"dutyCertificateId":{"description":"The certificate identifier used to locate a certificate in the certificate file.\n","type":"string"},"dutyEndDate":{"description":"The duty end date. This is normally populated when duty ends. During ongoing duty, the\nvalue will remain empty.\n","format":"date","nullable":true,"type":"string"},"dutyServiceComponent":{"description":"DoD's classification of service positions\n","type":"string"},"dutyServiceComponentDescription":{"description":"Description of DoD's classification of service positions\n","nullable":true,"type":"string"},"dutyServiceMatchDate":{"description":"The date that DMDC completed the SCRA match.\n","format":"date","nullable":true,"type":"string"},"dutyStartDate":{"description":"The duty start date. This is populated when Peach gets the first hit from the SCRA database.\n","format":"date","type":"string"},"memberOfPennsylvaniaNationalGuard":{"description":"The borrower is a member of Pennsylvania National Guard.","type":"boolean"},"onDutyProtectionEligibility":{"description":"The borrower's eligibility for the federal SCRA and/or state protections","enum":["federal","state","federalAndState"],"nullable":true,"type":"string"}},"title":"militaryDuty","type":"object"}},"components/schemas/DebtValidation":{"id":"components/schemas/DebtValidation","kind":"json-schema","title":"debtValidation","data":{"description":"Debt validation case","properties":{"caseType":{"enum":["debtValidation"],"type":"string"},"currentStateResidence":{"description":"Borrower's current state of residence. Use two character US state name abbreviations.\n","type":"string"},"newYorkStateCity":{"description":"If the borrower is a New York state resident, specify the city.\n","enum":["newYorkCity","yonkers","other"],"nullable":true,"type":"string"},"requestDate":{"description":"Date the debt validation was requested.","format":"date","type":"string"}},"title":"debtValidation","type":"object"}},"components/schemas/Collection":{"id":"components/schemas/Collection","kind":"json-schema","title":"collection","data":{"description":"Collection case","properties":{"attemptsToContactByPhone":{"properties":{"attempted":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of attempted case-associated phone interactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the borrower. Attempted statuses are those not in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"successful":{"description":"The number of successful case-associated phone interactions\nwith the borrower.\n","type":"integer"}},"readOnly":true,"type":"object"},"caseType":{"enum":["collection"],"type":"string"},"collectionReachOuts":{"properties":{"capacities":{"items":{"properties":{"count":{"description":"How many contacts were made in the last period, ending\ntoday.\n","type":"integer"},"left":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many contacts are left according to the intensity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is not configured."},"children":[]}]}]}],"nullable":true,"type":"integer"},"period":{"description":"The length of the time period, in days.\n","type":"integer"}},"type":"object"},"type":"array"},"contacts":{"items":{"properties":{"count":{"description":"How many contacts were made on the given day.\n","type":"integer"},"date":{"description":"The date on the contacts were made.\n","format":"date","type":"string"}},"type":"object"},"type":"array"},"intensity":{"description":"The borrower's collection intensity rate.","enum":["light","normal","heavy"],"type":"string"}},"type":"object"},"daysOverdue":{"description":"Maximum number of days overdue among overdue or accelerated loans.","readOnly":true,"type":"integer"},"isFirstTimeCollection":{"description":"Indicates if this is the first time a collections case-type has\nbeen created for this borrower. Canceled cases are not\nconsidered.\n","readOnly":true,"type":"boolean"},"lastSuccessfulPayment":{"properties":{"amount":{"description":"The amount of the last successful payment (transaction).","format":"float","type":"number"},"date":{"description":"The date of the last successful payment (transaction) among overdue and accelerated loans.","format":"date","type":"string"}},"readOnly":true,"type":"object"},"loansReportedToBureaus":{"enum":["yes","no","some"],"readOnly":true,"type":"string"},"nextPayment":{"description":"Closest upcoming payment due of overdue and accelerated loans.","properties":{"amount":{"description":"Upcoming payment amount.","format":"float","type":"number"},"date":{"description":"Upcoming payment date.","format":"date","type":"string"}},"readOnly":true,"type":"object"},"numberOfLoansOverdueOrAccelerated":{"description":"Number of associated overdue or accelerated loans.","readOnly":true,"type":"integer"},"overdueOrAcceleratedLoanCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfLoansOverdueOrAccelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of associated overdue or accelerated loans."},"children":[]}]}]}],"readOnly":true,"type":"integer"},"paymentCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentCounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"failed":{"description":"The number of failed payments (transactions) among overdue and accelerated loans.","type":"integer"},"total":{"description":"The total number of payment attempts (transactions) among overdue and accelerated loans.","type":"integer"}},"readOnly":true,"type":"object"},"paymentCounts":{"properties":{"failed":{"description":"The number of failed payments (transactions) among overdue and accelerated loans.","type":"integer"},"total":{"description":"The total number of payment attempts (transactions) among overdue and accelerated loans.","type":"integer"}},"readOnly":true,"type":"object"},"totalAmounts":{"properties":{"expected":{"description":"Total amount expected to be paid on overdue and accelerated loans.","format":"float","type":"number"},"overdue":{"description":"Total amount overdue on overdue or accelerated loans.","format":"float","type":"number"},"paid":{"description":"Total amount paid on overdue and accelerated loans.","format":"float","type":"number"}},"readOnly":true,"type":"object"}},"title":"collection","type":"object"}},"components/schemas/OFACAddress":{"id":"components/schemas/OFACAddress","kind":"json-schema","title":"OFACAddress","data":{"properties":{"address":{"description":"The address.","type":"string"},"cityStateProvincePostalCode":{"description":"City, state, province, or postal code.","type":"string"},"country":{"description":"The country.","type":"string"}},"type":"object"}},"components/schemas/OFACSanctionedIndividual":{"id":"components/schemas/OFACSanctionedIndividual","kind":"json-schema","title":"oFACSanctionedIndividual","data":{"description":"Keyword parameters unique to OFAC sanctioned individuals.","properties":{"caseType":{"enum":["oFACSanctionedIndividual"],"type":"string"},"ofacActionsRequired":{"description":"The list of standard punitive actions.","items":{"enum":["blockTransaction","rejectTransaction","closeAccount","blockAssets"],"type":"string"},"type":"array"},"ofacActionsRequiredOther":{"description":"Additional punitive actions.","type":"string"},"sdnAddressList":{"description":"List of addresses.","items":{"$ref":"#/components/schemas/OFACAddress"},"type":"array"},"sdnAkaList":{"description":"List of AKA's, in the format of \"LASTNAME, Firstname\".","items":{"type":"string"},"type":"array"},"sdnDateOfBirthList":{"description":"Dates of birth. The date may be partial. For example: 10 Dec 1948 or 1959.\n","items":{"type":"string"},"type":"array"},"sdnName":{"description":"Name of the Specially Designated National.\n","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"}},"type":"object"},"sdnNationalityList":{"description":"List of nationalities. For example: Tunisia.\n","items":{"type":"string"},"type":"array"},"sdnPlaceOfBirthList":{"description":"Places of birth. For example: Cuba.\n","items":{"type":"string"},"type":"array"},"sdnProgramList":{"description":"List of sanction program names. For example: SDNTK or SDGT.\n","items":{"type":"string"},"type":"array"},"sdnRemarks":{"description":"Specially Designated National remarks.\n","type":"string"},"sdnUid":{"description":"Unique record identifier/unique listing identifier.\n","type":"string"}},"title":"oFACSanctionedIndividual","type":"object"}},"components/schemas/PurchaseDispute":{"id":"components/schemas/PurchaseDispute","kind":"json-schema","title":"PurchaseDispute","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"cardId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked to the disputed purchase ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mirrors "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase.cardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the underlying purchase."},"children":[]}]}]}],"nullable":true,"readOnly":true,"type":"string"},"caseId":{"description":"Peach identifier of the case. The case object contains more details about the dispute, e.g. evidence information such as supporting documents.\n","type":"string"},"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"disputedAmount":{"description":"The disputed amount. Can be less than the original purchase amount. Sum of disputed amounts cannot exceed the original purchase amounts (regardless of disputes outcomes).\n","format":"float","type":"number"},"metadata":{"additionalProperties":true,"type":"object"},"repostedPurchaseId":{"description":"The identifier of the reposted purchase. When a borrower loses a dispute, the lender normally creates a new purchase in the amount of the dispute.\n","type":"string"},"status":{"default":"unsubmitted","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the dispute. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubmitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only valid status for a new purchase dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubmitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute is pending submission to a processor/network."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute has been submitted to a processor/network."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"won"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute is won."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute is lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The dispute was canceled. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubmitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disputes can be canceled."},"children":[]}]}]}],"enum":["unsubmitted","submitted","expired","won","lost","canceled"],"type":"string"},"timestamps":{"properties":{"expiredAt":{"format":"date-time","type":"string"},"lostAt":{"format":"date-time","type":"string"},"submittedAt":{"format":"date-time","type":"string"},"wonAt":{"format":"date-time","type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}]}},"components/schemas/CanceledDetails":{"id":"components/schemas/CanceledDetails","kind":"json-schema","title":"canceledDetails","data":{"properties":{"cancelPolicyProvided":{"description":"Whether the borrower was provided with a cancellation policy by the merchant.\n","type":"boolean"},"cancelReason":{"description":"Reason for canceling the order.\n","type":"string"},"canceledDate":{"description":"Date when the order was canceled.","format":"date","type":"string"},"expectedDate":{"description":"Date the borrower expected to receive the order.\n","format":"date","type":"string"},"productDescription":{"description":"Description of the merchandise or service that was purchased.\n","type":"string"},"productType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of product purchased."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchandise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tangible goods such as appliances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Intangible goods such as ski lessons or internet subscription."},"children":[]}]}]}],"enum":["merchandise","service"],"type":"string"},"returnStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of borrower's attempt to return the product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant accepted the return."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantRejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant rejected the return."},"children":[]}]}]}],"enum":["succeeded","merchantRejected"],"type":"string"},"returnedDate":{"description":"Date when the order was returned or attempted to be returned.","format":"date","type":"string"}},"title":"canceledDetails","type":"object"}},"components/schemas/DuplicateDetails":{"id":"components/schemas/DuplicateDetails","kind":"json-schema","title":"duplicateDetails","data":{"properties":{"cardStatementDocumentId":{"description":"Copy of the card statement showing that the product had already been paid for.\n","type":"string"},"cashReceiptDocumentId":{"description":"Copy of the receipt showing that the product had been paid for in cash.\n","type":"string"},"checkImageDocumentId":{"description":"Image of the front and back of the check that was used to pay for the product.\n","type":"string"},"originalPurchaseExternalId":{"description":"External Purchase identifier that the disputed purchase is a duplicate of. If the two or more purchases that are copies of each other (aka have exact same details), this is the original undisputed one.\n","type":"string"}},"title":"duplicateDetails","type":"object"}},"components/schemas/MerchandiseNotAsDescribedDetails":{"id":"components/schemas/MerchandiseNotAsDescribedDetails","kind":"json-schema","title":"merchandiseNotAsDescribedDetails","data":{"properties":{"receivedDate":{"description":"Date when the product was received.","format":"date","type":"string"},"returnDescription":{"description":"Description of the borrower's attempt to return the product.","type":"string"},"returnStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of borrower's attempt to return the product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant accepted the return."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantRejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant rejected the return."},"children":[]}]}]}],"enum":["succeeded","merchantRejected"],"type":"string"}},"title":"merchandiseNotAsDescribedDetails","type":"object"}},"components/schemas/NotReceivedDetails":{"id":"components/schemas/NotReceivedDetails","kind":"json-schema","title":"notReceivedDetails","data":{"properties":{"expectedDate":{"description":"Date the borrower expected to receive the order.\n","format":"date","type":"string"},"productDescription":{"description":"Description of the merchandise or service that was purchased.\n","type":"string"},"productType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of product purchased."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchandise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tangible goods such as appliances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Intangible goods such as ski lessons or internet subscription."},"children":[]}]}]}],"enum":["merchandise","service"],"type":"string"}},"title":"notReceivedDetails","type":"object"}},"components/schemas/OtherDetails":{"id":"components/schemas/OtherDetails","kind":"json-schema","title":"otherDetails","data":{"properties":{"productDescription":{"description":"Description of the merchandise or service that was purchased.\n","type":"string"},"productType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of product purchased."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchandise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Tangible goods such as appliances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Intangible goods such as ski lessons or internet subscription."},"children":[]}]}]}],"enum":["merchandise","service"],"type":"string"}},"title":"otherDetails","type":"object"}},"components/schemas/ServiceNotAsDescribedDetails":{"id":"components/schemas/ServiceNotAsDescribedDetails","kind":"json-schema","title":"serviceNotAsDescribedDetails","data":{"properties":{"cancelReason":{"description":"Reason for canceling the order.\n","type":"string"},"canceledDate":{"description":"Date when the order was canceled.","format":"date","type":"string"},"receivedDate":{"description":"Date when the product was received.","format":"date","type":"string"}},"title":"serviceNotAsDescribedDetails","type":"object"}},"components/schemas/EvidenceDetails":{"id":"components/schemas/EvidenceDetails","kind":"json-schema","title":"EvidenceDetails","data":{"oneOf":[{"$ref":"#/components/schemas/CanceledDetails"},{"$ref":"#/components/schemas/DuplicateDetails"},{"$ref":"#/components/schemas/MerchandiseNotAsDescribedDetails"},{"$ref":"#/components/schemas/NotReceivedDetails"},{"$ref":"#/components/schemas/OtherDetails"},{"$ref":"#/components/schemas/ServiceNotAsDescribedDetails"}]}},"components/schemas/PurchaseDeclineReason":{"id":"components/schemas/PurchaseDeclineReason","kind":"json-schema","title":"PurchaseDeclineReason","data":{"description":"The reason the purchase was declined","properties":{"mainExternalReasonCode":{"description":"The external decline reason code","type":"string"},"mainScriptForRep":{"description":"The main decline reason script that a customer service agent can provide to the borrower.","type":"string"},"mainText":{"description":"The main decline reason text that is shown to the borrower","type":"string"}},"type":"object"}},"components/schemas/PurchaseMigrationDetails":{"id":"components/schemas/PurchaseMigrationDetails","kind":"json-schema","title":"PurchaseMigrationDetails","data":{"description":"Purchase migration related details. This object should be used for lines that are migrated from another system to Peach.\n","properties":{"originalDrawId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw identifier. Can be Peach or lender's external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All past purchases prior to the \"migration cutoff date\" will be posted on the \"migration\" draw. After the \"migration cutoff date\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a lender can have multiple draws (e.g. Purchases, Cash Withdrawals, etc.) Use this attribute to indicate the original draw ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the purchase was posted on in another system. In case of a dispute created after the \"migration cutoff date\", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be used to adjust the draw balance. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for all purchases that are migrated from another system."},"children":[]}]}]}],"nullable":true,"pattern":"^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string"}},"required":["originalDrawId"],"type":"object"}},"components/schemas/PurchaseDetails":{"id":"components/schemas/PurchaseDetails","kind":"json-schema","title":"PurchaseDetails","data":{"description":"The details of purchase.","properties":{"categoryId":{"description":"The category identifier of the purchase.","nullable":true,"type":"string"},"conversionRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversion rate that was used to convert the purchase amount from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the line of credit main currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit main currency code = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrencyCode=GBP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrencyAmount=200.45"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversionRate=1.33"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount = 200.45 * 1.33 = 266.59"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"description":{"default":"Purchase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the purchase. Purchases in authorized status are shown in borrower portal but NOT on statements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchases in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status are shown in borrower portal and on statements.  At least one of the attributes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed"},"children":[]}]}]}],"nullable":true,"type":"string"},"externalCardId":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED. Use the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on Create/Update Purchase instead, which resolves to a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" row scoped to the line of credit. This legacy field is preserved for back-compat and continues"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to populate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column verbatim."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Precedence: if both top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDetails.externalCardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supplied in the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wins and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is silently ignored (no error, no warning)."},"children":[]}]}]}],"nullable":true,"type":"string"},"isValidMerchantId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID exists in Peach Merchants table."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID doesn't exist in Peach Merchants table."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit card lenders normally should not create merchants details in Peach and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute can be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point of sale lenders normally have merchants details in Peach and can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute as needed."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"merchantCategoryCode":{"description":"The merchant category code of the card acceptor (merchant).","nullable":true,"type":"string"},"merchantCity":{"description":"The city of the merchant.","nullable":true,"type":"string"},"merchantCountry":{"description":"The country of the merchant.","nullable":true,"type":"string"},"merchantId":{"description":"The merchant identifier where the purchase was made.","nullable":true,"type":"string"},"merchantName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant name where the purchase was made. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"nullable":true,"type":"string"},"merchantState":{"description":"The state of the merchant.","nullable":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"},"originalCurrencyAmount":{"description":"The amount of the purchase before currency conversion.","format":"float","nullable":true,"type":"number"},"originalCurrencyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in which the purchase was made before currency conversion. Three letters according to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_4217"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"pattern":"[A-Z]{3}","type":"string"},"pointOfSaleType":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was made online on a website or in a mobile application."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was made in a store with a physical card or instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was made as part of a subscription service."},"children":[]}]}]}]}],"enum":["online","physical","recurring"],"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/PurchaseStatus":{"id":"components/schemas/PurchaseStatus","kind":"json-schema","title":"PurchaseStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase is authorized and not yet "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases are included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utilizationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calculations; however, authorizations are not written to the ledger and are not included in total outstanding loan balances."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase is pending. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purchases increases the draw balance similar to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pending status is used mainly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for visuals and normally shown in Borrower Portal and on statements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was canceled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purchases reduce the draw balance. A new purchase cannot be created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the purchase was declined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purchases reduce the draw balance if the status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A new purchase can be created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for record purposes (it will not impact the draw balance)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The purchase was disputed for full or partial amount. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is a terminal state and once set cannot be changed to another status. This status can not be set manually. Submitting a purchase dispute will set the purchase's status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status transitions are allowed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only by calling \"Create purchase dispute\")"},"children":[]}]}]}]}],"enum":["authorized","pending","settled","canceled","declined","disputed"],"type":"string"}},"components/schemas/CreatePurchase":{"id":"components/schemas/CreatePurchase","kind":"json-schema","title":"Purchase","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the purchase. The amount can be updated only if the purchase status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The amount and status of a purchase may be changed on the same call."},"children":[]}]}]}],"format":"float","minimum":0,"type":"number"},"authorizationPurchaseId":{"description":"Peach's unique (or lender's external identifier) for the authorization purchase. This attribute is used to reference an initial authorization, so\nlenders know which captures (purchase object(s) in Peach) are related to the original authorization.\n","nullable":true,"type":"string"},"cardId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach id, Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or lender external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the card used for this purchase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolved against cards belonging to this line of credit. If the card cannot be resolved (unknown id or wrong loan),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the purchase is still created and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation.cardIdMissing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In responses from read endpoints, this field is always returned as the Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":200,"nullable":true,"type":"string"},"declineReason":{"$ref":"#/components/schemas/PurchaseDeclineReason","description":"The reason the purchase was declined","nullable":true},"displayId":{"description":"The purchase ID to show in the UI (Peach public or external).","readOnly":true,"type":"string"},"drawId":{"description":"The unique identifier of the draw that the purchase belongs to.","readOnly":true,"type":"string"},"eligibleDisputeAmount":{"description":"The maximum amount eligible to be disputed. The amount is dynamic and can change depending on past disputes. Sum of disputed amounts cannot exceed the original purchase amounts (regardless of disputes outcomes).\n","format":"float","readOnly":true,"type":"number"},"externalId":{"$ref":"#/components/schemas/externalId","description":"The external unique identifier of the purchase."},"id":{"description":"The unique identifier of the purchase.","readOnly":true,"type":"string"},"lineOfCreditId":{"description":"The unique identifier of the line of credit that the purchase belongs to.","readOnly":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"},"migration":{"$ref":"#/components/schemas/PurchaseMigrationDetails","nullable":true},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original amount of the purchase when it was created. If the purchase amount changes after creation, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not change."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"originalPurchaseId":{"$ref":"#/components/schemas/AnyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's unique or lender's external identifier. Typically used for purchases of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which allows the lender to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the original purchase being refunded. For authorizations, please see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}],"nullable":true},"purchaseDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of a purchase. This attribute can be passed only during the line of credit migration process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't use this attribute after the migration process was successfully completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be before or equal to today, and cannot be greater than the \"migration at date\" (aka the actual date on which you run the migration.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you cannot pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at 6:00 AM in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, you must pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-migrated purchases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is equal to the date part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" converted to the product timezone (e.g. Eastern or Pacific)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null, this value is equal to the date part of the purchase's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" converted to the product timezone."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in Get endpoints for both migrated and non-migrated purchases."},"children":[]}]}]}],"format":"date","type":"string"},"purchaseDetails":{"$ref":"#/components/schemas/PurchaseDetails"},"status":{"allOf":[{"$ref":"#/components/schemas/PurchaseStatus"},{"default":"settled"}]},"timestamps":{"properties":{"authorizedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the purchase was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value can be set by lenders at the time of purchase creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not set by the lender, it will be populated based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if it is non-null) otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not set by the lender and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, this value corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase.authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the purchase was never in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and none of the prior conditions are met, this value will be null."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"effectiveAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective timestamp when the purchase was applied in the ledger. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to the timestamp when the purchase is set to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, whichever comes first. Changing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Update purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint will trigger a replay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the line of credit. Keep in mind that an existing statement might've included the purchase based on the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the interest was accrued based on the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated only if the purchase is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"format":"date-time","readOnly":true,"type":"string"},"settledAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the purchase was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase.settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"updatedAt":{"format":"date-time","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"type":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regular"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a regular purchase made by the borrower. Increases draw's balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a refund of the purchase made in the past. Decreases draw's balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashBack"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cash back given to the borrower by the issuing institution."},"children":[]}]}]}]}],"enum":["regular","refund","cashBack"],"type":"string"}},"required":["amount"],"title":"Purchase","type":"object"}},"components/schemas/InternalRefundDetails":{"id":"components/schemas/InternalRefundDetails","kind":"json-schema","title":"InternalRefundDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of how a refund was applied:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will first deplete any non-due principal. This amount will be stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundNonDuePrincipalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any refund amount is left to apply, the system will create a transaction of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCreditType=refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This transaction will be applied on the Draw level first and any leftover amount will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be applied on the LOC level (based on the loan type waterfall configuration for payments). This amount will be stored as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundTransactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any unapplied refund amount will be recorded as credit to the borrower (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}]}],"properties":{"refundNonDuePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of refund that was applied to reduce the non-due principal of the draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of refund is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundNonDuePrinicpalAmount + refundTransactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"refundTransactionAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of refund that was applied to as a transaction to reduce other balances of the draw and potentially other draws."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of refund is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundNonDuePrinicpalAmount + refundTransactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"refundTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to the transaction ID of type service credit and serviceCreditType=refund. This is Peach Public ID."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/Purchase":{"id":"components/schemas/Purchase","kind":"json-schema","title":"Purchase","data":{"allOf":[{"$ref":"#/components/schemas/CreatePurchase"},{"properties":{"refundDetails":{"$ref":"#/components/schemas/InternalRefundDetails","nullable":true,"readOnly":true}},"type":"object"}]}},"components/schemas/DisputeOfPurchase":{"id":"components/schemas/DisputeOfPurchase","kind":"json-schema","title":"disputeOfPurchase","data":{"properties":{"caseType":{"enum":["disputeOfPurchase"],"type":"string"},"dispute":{"$ref":"#/components/schemas/PurchaseDispute"},"disputeReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for filing the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Service or merchandise was canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceNotAsDescribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The service was not as described."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchandiseNotAsDescribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchandise was not as described."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There were multiple copies of a charge for a single purchase, or the charge was paid by other means."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudulent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The borrower did not make the purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notReceived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Merchandise or service was not received."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - All other types of disputes."},"children":[]}]}]}],"enum":["canceled","serviceNotAsDescribed","merchandiseNotAsDescribed","duplicate","fraudulent","notReceived","other"],"type":"string"},"disputeStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dispute.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["unsubmitted","submitted","expired","won","lost"],"readOnly":true,"type":"string"},"evidenceDetails":{"$ref":"#/components/schemas/EvidenceDetails"},"evidenceDocumentId":{"description":"Additional document supporting the dispute.","type":"string"},"evidenceExplanation":{"description":"Description of why the borrower disputes the purchase.","type":"string"},"purchase":{"$ref":"#/components/schemas/Purchase"},"purchaseDisputeId":{"description":"Peach identifier of the dispute object that belongs to the purchase.\n","type":"string"},"purchaseExternalId":{"description":"The external identifier of the disputed purchase.","type":"string"},"purchaseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach identifier of the disputed purchase. You must supply this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a case."},"children":[]}]}]}],"type":"string"}},"title":"disputeOfPurchase","type":"object"}},"components/schemas/CreditBureauDisputeCodes":{"id":"components/schemas/CreditBureauDisputeCodes","kind":"json-schema","title":"CreditBureauDisputeCodes","data":{"enum":["notMine","belongsToAnotherWithSimilarName","notAwareOfCollection","settlementOrPartialPaymentAccepted","claimsPaidCreditorBeforeCollectionOrChargeOff","creditLimitOrLoanAmountIncorrect","includedInTheBankruptcyOfAnother","claimsAccountClosed","claimsAccoutClosedByConsumer","contractCanceledOrRescinded","accountIncludedInBankruptcy","claimsActiveMilitaryDuty","insuranceClaimDelayed","accountInvolvedInLitigation","claimsVictimOfNaturalOrDeclaredDisaster","claimsAccountDeferred","notLiable","accountReaffirmedOrNotIncludedInBankruptcy","claimsTrueIdentityFraud","claimsAccountTakeOver","disputesPresentPreviousAccountStatusPaymentRatingAccountHistory","disputesPortfolioTypeAccountTypeOrTermsDurationFrequency","claimsCompanyWillChange","claimsCompanyWillDelete","consumerStatesInaccurateInformation","disputesDateOpenedDateOfLastPaymentOrDateClosed","disputesDateOfFirstDeliquency","disputesComplianceConditions","disputesSpecialCommentCodeAndOrNarrativeRemarks","disputesCurrentBalanceAndOrAmountPastDue","disputesOriginalChargeOffPaymentOrScheduledPaymentAmount","consumerDisputesDeceasedECOA"],"type":"string"}},"components/schemas/CreditBureauDisputeResponseCodes":{"id":"components/schemas/CreditBureauDisputeResponseCodes","kind":"json-schema","title":"CreditBureauDisputeResponseCodes","data":{"enum":["informationAccurateAsOfReportDate","deleteAccount","misroutedACDV","deleteDueToFraud","updateDisputedAccountInfoOnly","updateDisputedAndAdditionalAccountInfo","disputedInformationAccurateUpdatedAdditionalInfo","consumersDisputeNotSpecific","other"],"type":"string"}},"components/schemas/CreditBureauDispute":{"id":"components/schemas/CreditBureauDispute","kind":"json-schema","title":"creditBureauDispute","data":{"properties":{"bureauDisputeNotice":{"description":"ID for the interaction that resulted in the dispute case being opened","type":"string"},"caseType":{"enum":["creditBureauDispute"],"type":"string"},"disputeCode1":{"$ref":"#/components/schemas/CreditBureauDisputeCodes","description":"The nature of the consumer's dispute."},"disputeCode2":{"$ref":"#/components/schemas/CreditBureauDisputeCodes","description":"Optional second dispute reason.","nullable":true},"disputeReceivedDate":{"description":"The date the dispute was received. This is the date the ACDV was\nplaced in the data furnisher's queue.\n","format":"date","type":"string"},"fcraInfo":{"description":"Contains a description of the FCRA-mandated relevant information\nreceived from the consumer pertaining to this dispute. This is a\nfree-form text area.\n","nullable":true,"type":"string"},"responseCode":{"$ref":"#/components/schemas/CreditBureauDisputeResponseCodes","description":"A code that indicates the action the data furnisher wants the\noriginating agency to take in response to the dispute.\n"},"responseDueDate":{"description":"The date by which an ACDV response must be received from a data\nfurnisher. After this date, the ACDV is removed from the queue\nand the originating agency will take action per the\nspecifications of the Fair Credit Reporting Act (FCRA).\n","format":"date","nullable":true,"type":"string"}},"title":"creditBureauDispute","type":"object"}},"components/schemas/CasePut":{"id":"components/schemas/CasePut","kind":"json-schema","title":"case","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/CaseAttributes"},{"anyOf":[{"$ref":"#/components/schemas/Bankruptcy"},{"$ref":"#/components/schemas/CeaseCommunication"},{"$ref":"#/components/schemas/Deceased"},{"$ref":"#/components/schemas/DisputeOfDebt"},{"$ref":"#/components/schemas/FederalEmergency"},{"$ref":"#/components/schemas/GenericCase"},{"$ref":"#/components/schemas/IdentityTheft"},{"$ref":"#/components/schemas/LegalAction"},{"$ref":"#/components/schemas/MilitaryDuty"},{"$ref":"#/components/schemas/DebtValidation"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/OFACSanctionedIndividual"},{"$ref":"#/components/schemas/DisputeOfPurchase"},{"$ref":"#/components/schemas/CreditBureauDispute"}]}],"title":"case"}},"components/schemas/Case":{"id":"components/schemas/Case","kind":"json-schema","title":"case","data":{"allOf":[{"$ref":"#/components/schemas/CasePut"},{"properties":{"typeId":{"description":"Unique identifier of the case type.\n","type":"string"}},"required":["typeId"],"type":"object"}],"title":"case"}},"components/schemas/OverrideTemplateId":{"id":"components/schemas/OverrideTemplateId","kind":"json-schema","title":"OverrideTemplateId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The template version ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TV-AAAA-BBBB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template descriptor ID (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TD-AAAA-BBBB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a template descriptor is given, then the current template descriptor's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activeVersionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This should be used in special cases where you do not want to use the implicit template selected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"example":"TV-AAAA-BBBB","nullable":true,"type":"string"}},"components/schemas/InteractionStatusDetails":{"id":"components/schemas/InteractionStatusDetails","kind":"json-schema","title":"InteractionStatusDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides more details about the status of an interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to the \"technical\" status of an interaction: e.g., Did it connect?"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Did it fail to send? Was it blocked by Compliance Guard?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the \"human\" outcome of an interaction see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": e.g., Did you talk the person you intended"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to? Did the other chat recipient become unresponsive?"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certain status details must have a particular "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with them; attempting to use them"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise will result in an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status details are considered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailDelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The email was successfully delivered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailOpened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The email was opened"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailClick"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A link in the email was clicked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The letter is successfully delivered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chatRead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The chat message was read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status detail is only available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailIsCertified=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterPickUpAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is available for pickup at carrier location"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempted"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status details are considered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=attempted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceReceivedOutsideOpenHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Caller tried to contact the lender outside designated business hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceConnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Voice call connected successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceDisconnectedBeforeQueue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Inbound call was disconnected before entering the queue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailSent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email was sent, but delivery cannot be confirmed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterCreated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is successfully created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterRenderedPdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter's PDF proof is successfully rendered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterRenderedThumbnails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter's thumbnails are successfully rendered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterInTransit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter received an \"In Transit\" event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterInLocalArea"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is in the local area"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterProcessedForDelivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is in the local area"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterRerouted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is re-routed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chatPosted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Chat message sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textConvoTimeoutAutoclose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This text conversation was closed automatically due to a timeout."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textConvoClosedStale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") An open but outdated text conversation was closed automatically when a new text conversation was started. New text conversations should never enter into this state, but old conversations may be in this state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textConvoClosedByAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The agent manually marked the text conversation as ended."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status details are only available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailIsCertified=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterAccepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has been accepted into the carrier network for delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterArrived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has arrived at an intermediate location in the carrier network"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterContactCarrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has non-failure condition that requires contacting the carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDamaged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has been damaged; contact carrier for more details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDelayed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has been delayed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDeliveryAttempted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Carrier attempted to deliver letter; contact carrier to ensure delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDeliveryRescheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delivery of letter has been rescheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDeparted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has departed from an intermediate location in the carrier network"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterHeld"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter held at carrier location; contact carrier for more details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterNoticeLeft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Carrier left notice during attempted delivery; follow instructions on notice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has been processed at an intermediate location"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterProcessing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is processing at an intermediate location in the carrier network"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterOther"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach's mail partner received an unrecognized status that does not have a predefined code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status details are considered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generally an interaction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if some part of connecting or completing the interaction failed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due to a technical failure, misconfiguration, or attempt to communicate in a way disallowed by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailBlocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving server could not or would not accept the message temporarily"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailBounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving server could not or would not accept mail to this recipient permanently"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailDropped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email rejected for a number of reasons: rejected as SPAM, Unsubscribed Address, Bounced Address, Email Invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailFailedToSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not currently in use - reserved for future use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailReportedAsSpam"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email was delivered, but later reported as SPAM by recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDeleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is successfully canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterFailedToCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Request to create the letter failed. Provider did not return 200 OK status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterReturnedToSender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is returned to the sender"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textA2PCampaignUnregistered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The text was not sent because the lender has not registered this phone number with an A2P campaign."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textAccountSuspended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The account was suspended between message queuing and delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textCarrierViolation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The message was flagged as 'objectionable' or 'spam' by the phone carrier and was blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textConvoUnknownNumberRejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This text was received from an unknown number, and so was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textDeviceUnreachable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The destination phone number temporarily could not be reached - it was turned off, out of service area, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textLandlineOrUnreachableCarrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The destination phone number could not receive the message. Reasons include the destination number being a landline phone or the carrier being temporarily unavailable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textLenderDisabledInboundTexts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The inbound text was not received because the lender does not have inbound texting enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textMessageBlocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The destination phone number is blocked from receiving the message."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textMessagePriceExceedsMax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The price of the message exceeds the max price parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textMissingSegment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - One or more parts of a multipart message were not received."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textNumberDisconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The destination phone number could not be reached and may be disconnected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textQueueOverflow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Too many messages were queued to be sent, and some were dropped as a result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textRegionInvalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Permission to send an SMS or MMS has not been enabled for the region indicated by the 'To' number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textUnknownError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An unknown error occurred when attempting to send the message."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"textUnsubscribedRecipient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The person you are trying to message has opted out of receiving messages from your Twilio phone number, Channels sender, or Messaging Service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceFailedToInitiate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Outbound voice call could not start for some reason; Or the inbound call was disconnected before entering the queue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceLenderDisabledInboundCalls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Inbound call received while lender has inbound voice call disabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceNumberDisconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Outbound voice call to disconnected phone number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceNumberInvalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid 'To' Phone Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceReceivedNoAgentsAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Inbound call received while lender had no agents to answer it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following status details are only available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailIsCertified=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterAddressIssue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Address information is incorrect; contact carrier to ensure delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterDisposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter disposed by carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterLocationInaccessible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delivery location inaccessible to carrier; contact carrier to ensure delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterLost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter has been lost; contact carrier for more details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterRescheduleDelivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contact carrier to reschedule delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterUnclaimed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter is unclaimed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letterUndeliverable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Letter was unable to be delivered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channels"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most status details can only be used with their respective channels. e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceNumberDisconnected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can only be used for interactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Using them otherwise will result in an error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalidContact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockedByComplianceGuard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are valid for all channels"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certain status details are only valid with certain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settings. Using them with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will result in an error. For example..."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceReceivedNoAgentsAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be set for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phone calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceNumberDisconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be set for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phone calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceUnexpectedDisconnect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be set for either direction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid status name but rather can be used to specify a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query for interactions with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"enum":["voiceSpokeWithFirstParty","voiceSpokeWithThirdParty","voiceLeftVoicemailFirstParty","voiceLeftVoicemailThirdParty","voiceLeftVoicemail","voiceLineBusyNoRing","voiceReachedVoicemailNoMessageLeft","voiceRangNoPickup","voicePickedHungUp","voiceFailedToInitiate","voiceNumberDisconnected","voiceReceivedOutsideOpenHours","voiceUnexpectedDisconnect","voiceDisconnectedBeforeQueue","voiceDisconnectedWhileQueuedOnHold","voiceReceivedNoAgentsAvailable","voiceLenderDisabledInboundCalls","voiceConnected","voiceNumberInvalid","emailSent","emailDelivered","emailBlocked","emailBounced","emailOpened","emailClick","emailDropped","emailFailedToSend","emailReportedAsSpam","letterCreated","letterFailedToCreate","letterRenderedPdf","letterRenderedThumbnails","letterProcessedForDelivery","letterRerouted","letterInLocalArea","letterInTransit","letterDelivered","letterReturnedToSender","letterDeleted","letterAccepted","letterArrived","letterProcessing","letterProcessed","letterDeparted","letterPickUpAvailable","letterAddressIssue","letterContactCarrier","letterDelayed","letterDeliveryAttempted","letterDeliveryRescheduled","letterLocationInaccessible","letterNoticeLeft","letterDamaged","letterDisposed","letterHeld","letterLost","letterUnclaimed","letterUndeliverable","letterRescheduleDelivery","letterOther","chatPosted","chatRead","chatBorrowerInactivity","chatReceivedOutsideOpenHours","textConvoTimeoutAutoclose","textConvoClosedStale","textConvoUnknownNumberRejected","textConvoClosedByAgent","textLenderDisabledInboundTexts","textUnsubscribedRecipient","textQueueOverflow","textAccountSuspended","textDeviceUnreachable","textMessageBlocked","textNumberDisconnected","textLandlineOrUnreachableCarrier","textCarrierViolation","textUnknownError","textMissingSegment","textMessagePriceExceedsMax","textA2PCampaignUnregistered","textRegionInvalid","blockedByComplianceGuard","invalidContact","null"],"nullable":true,"type":"string"}},"components/schemas/BaseTwilioMinimalInteraction":{"id":"components/schemas/BaseTwilioMinimalInteraction","kind":"json-schema","title":"BaseTwilioMinimalInteraction","data":{"properties":{"borrowerSelectedTheme":{"$ref":"#/components/schemas/InteractionTheme"},"channel":{"type":"string"},"contactId":{"type":"string"},"content":{},"id":{"type":"string"},"metaData":{"$ref":"#/components/schemas/MetaData"},"personId":{"description":"The ID of the borrower to which this interaction is associated","nullable":true,"type":"string"},"scheduledAtFrom":{"description":"Time to start the scheduled interaction.\n","format":"date-time","type":"string"},"scheduledAtTo":{"description":"Time to end the scheduled interaction.\n","format":"date-time","type":"string"},"startedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the interaction. If not provided we'll assume it's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a timestamp of the API call.  If time of day is not required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide only date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For CRM-managed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"considered started when the CRM system answers the call, and an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call is considered started when the CRM system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"initiates the call."},"children":[]}]}]}],"format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/InteractionStatus"},"statusDetails":{"$ref":"#/components/schemas/InteractionStatusDetails"},"subject":{"$ref":"#/components/schemas/InteractionSubject"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"type":"object"}},"components/schemas/InteractionAgentOutcome":{"id":"components/schemas/InteractionAgentOutcome","kind":"json-schema","title":"InteractionAgentOutcome","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides details on the outcome of the interaction according to an agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note this captures the \"human\" outcome of an interaction: e.g., Did you talk the person you intended"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to? Did the other chat recipient become unresponsive?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the \"technical\" status of an interaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". e.g., : Did it fail to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send? Was it blocked by Compliance Guard?"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceSpokeWithFirstParty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent spoke with borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceSpokeWithThirdParty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent spoke with someone other than the borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceLeftVoicemail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent left voicemail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceReachedVoicemailNoMessageLeft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent reached voicemail but did not leave a message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceRangNoPickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Phone rang, no voicemail was reached, and the call ended, or the agent hung up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceLineBusyNoRing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent reached busy phone line"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voicePickedHungUp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Agent heard call pick up and immediate hang up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceDisconnectedWhileQueuedOnHold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Caller hung up while on hold"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceUnexpectedDisconnect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The call was unexpectedly disconnected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceFailedToInitiate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Outbound voice call could not start for some reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceNumberDisconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Outbound voice call to disconnected phone number"},"children":[]}]}]}]}],"enum":["voiceSpokeWithFirstParty","voiceSpokeWithThirdParty","voiceLeftVoicemail","voiceLineBusyNoRing","voiceReachedVoicemailNoMessageLeft","voiceRangNoPickup","voicePickedHungUp","voiceFailedToInitiate","voiceNumberDisconnected","voiceUnexpectedDisconnect"],"nullable":true,"type":"string"}},"components/schemas/InteractionIntensityCollDebt":{"id":"components/schemas/InteractionIntensityCollDebt","kind":"json-schema","title":"InteractionIntensityCollDebt","data":{"default":"normal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the maximum number of interactions per period(s) on a compliance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level related to FDCPA or state debt collection rules. Lenders can configure intensities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on their business needs. For example, prime borrowers can be defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"light"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a lender can define the maximum number of attempts or successful interactions to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 in any 7-calendar-day period."},"children":[]}]}]}],"enum":["light","normal","heavy"],"type":"string"}},"components/schemas/UserBase":{"id":"components/schemas/UserBase","kind":"json-schema","title":"UserBase","data":{"properties":{"companyId":{"readOnly":true,"type":"string"},"externalId":{"nullable":true,"type":"string"},"roleIds":{"description":"List of role IDs associated with this user.\n","items":{"type":"string"},"nullable":true,"type":"array"},"status":{"enum":["active","inactive"],"type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of user to create:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This user allows a borrower to log in to the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This user allows an agent to log in to the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This user is used in conjunction with an API key to perform background tasks."},"children":[]}]}]}]}],"enum":["borrower","agent","service"],"type":"string"}},"type":"object"}},"components/schemas/UserAuth":{"id":"components/schemas/UserAuth","kind":"json-schema","title":"UserAuth","data":{"properties":{"authType":{"$ref":"#/components/schemas/AuthType"},"authValueType":{"$ref":"#/components/schemas/AuthValueType"},"value":{"type":"string"}},"readOnly":true,"type":"object"}},"components/schemas/UserAuthList":{"id":"components/schemas/UserAuthList","kind":"json-schema","title":"UserAuthList","data":{"items":{"$ref":"#/components/schemas/UserAuth"},"readOnly":true,"type":"array"}},"components/schemas/UserBasic":{"id":"components/schemas/UserBasic","kind":"json-schema","title":"UserBasic","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/UserBase"},{"properties":{"auths":{"$ref":"#/components/schemas/UserAuthList"},"object":{"default":"user","enum":["user"],"readOnly":true,"type":"string"},"userId":{"description":"The ID of the associated user","type":"number"},"userName":{"readOnly":true,"type":"string"}},"type":"object"}]}},"components/schemas/BasePersonNoIdentity":{"id":"components/schemas/BasePersonNoIdentity","kind":"json-schema","title":"BasePersonNoIdentity","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":"\nRepresents various users such as a borrower,\nco-borrower, co-signer, etc. A lender can choose to provide PII or not.\nIf no PII is provided, Peach cannot monitor for bankruptcy, deceased and\nSCRA.\n","properties":{"borrowerType":{"default":"person","description":"The type of borrower.","enum":["person","business"],"type":"string"},"collectionsIntensity":{"$ref":"#/components/schemas/InteractionIntensityCollDebt"},"commPreferences":{"description":"The borrower's communication preferences.","properties":{"sendRemindersWhenCurrent":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system sends payment reminders when the loan is current."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the system sends payment reminders only when the loan is overdue."},"children":[]}]}]}],"type":"boolean"},"statementDeliveryChannels":{"description":"A list of channels that loan statements will be delivered.\nIf value(s) are not passed, the system will use the statement default channel from company's configuration.\nBorrower can modify their preferences later.\n","items":{"enum":["email","mail"],"type":"string"},"type":"array"}},"type":"object"},"companyId":{"description":"The unique company identifier.\n","type":"string"},"displayId":{"description":"The loan ID to show in the UI (Peach public or external).","readOnly":true,"type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for a borrower. After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"nullable":true,"type":"string"},"metaData":{"$ref":"#/components/schemas/MetaData"},"monitorStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only applicable to lenders who use Compliance Guard Monitor to monitor borrowers without active loans."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitorStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently used for Bankruptcy monitoring only in the following way."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bankruptcy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return only bankruptcy cases that were filed on or after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitorStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If date is passed (recommended), any bankruptcy cases filed prior to the date will be filtered and not returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend lenders to pass origination date of the earliest active loan in their system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If date is not passed, the system will set the date equal the borrower creation date."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"status":{"default":"active","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a new borrower object is created, we set the value to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at any time."},"children":[]}]}]}],"enum":["active","inactive"],"type":"string"},"statusUpdatedAt":{"description":"The time of a status update.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"user":{"allOf":[{"$ref":"#/components/schemas/UserBasic"},{"readOnly":true}]}},"type":"object"}]}},"components/schemas/InteractionDirection":{"id":"components/schemas/InteractionDirection","kind":"json-schema","title":"InteractionDirection","data":{"enum":["outbound","inbound"],"type":"string"}},"components/schemas/TaskType":{"id":"components/schemas/TaskType","kind":"json-schema","title":"TaskType","data":{"enum":["answerInboundVoiceCall","handleInboundInteraction","handleUnboundInboundInteraction","makeScheduledCall","replyToNewConvo","replyToNewText","replyToNewWebChat","replyToAbandonedWebChat","reviewEscalatedCaseAgent","reviewEscalatedCaseAgentUrgent","reviewEscalatedCaseTeam","reviewEscalatedCaseTeamUrgent","reviewDocumentUpload","reviewSnoozedCase","reviewAutoCreatedCase","reviewAutoUpdatedCase","reviewCaseInstructions","reviewVoicemail","smartReviewCase"],"type":"string"}},"components/schemas/AssociatedLoanId":{"id":"components/schemas/AssociatedLoanId","kind":"json-schema","title":"AssociatedLoanId","data":{"description":"The ID of a Loan. This marks a particular loan as associated with this interaction.\n","example":"LN-AAAA-BBBB","type":"string"}},"components/schemas/AssociatedLoanIds":{"id":"components/schemas/AssociatedLoanIds","kind":"json-schema","title":"AssociatedLoanIds","data":{"description":"The IDs of several loans. This marks several loans as associated with this interaction.","example":["LN-AAAA-BBBB","LB-CCCC-DDDD"],"items":{"type":"string"},"type":"array"}},"components/schemas/BaseInteraction":{"id":"components/schemas/BaseInteraction","kind":"json-schema","title":"BaseInteraction","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/BaseTwilioMinimalInteraction"},{"properties":{"agentOutcome":{"$ref":"#/components/schemas/InteractionAgentOutcome"},"agentOutcomeUpdatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime of the last "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentOutcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"borrower":{"$ref":"#/components/schemas/BasePersonNoIdentity"},"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"complianceGuardRuleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Compliance Guard rule identifier that blocked the interaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusDetails=blockedByComplianceGuard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a rule actually blocked the interaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases the interaction can be blocked before rules are checked (e.g. a borrower is missing an address)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In such a case the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complianceGuardRuleId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be empty/null."},"children":[]}]}]}],"nullable":true,"type":"string"},"contact":{"$ref":"#/components/schemas/ContactInformation"},"contactExternalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender's identifier of the contact information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This should not include any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix as we know this is an external ID field."},"children":[]}]}]}],"nullable":true,"type":"string","writeOnly":true},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for initiating the interaction.\nCan be an agent or automated system process.\n"},"direction":{"$ref":"#/components/schemas/InteractionDirection"},"endedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the interaction. This attribute is optional and is used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for logging only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For CRM-managed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interactions, a call is considered ended"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when either the borrower or the agent disconnects."},"children":[]}]}]}],"format":"date-time","nullable":true,"type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender's identifier for the interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"failureDescriptionLong":{"description":"Detailed text describing the failure reason and any appropriate actions the user may take to fix the issue.\n","nullable":true,"type":"string"},"failureDescriptionShort":{"description":"Short text describing the failure reason. Normally displayed in UI.\n","nullable":true,"type":"string"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean indicating the source of an Interaction. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction was supplied by the lender via API. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the interaction was created by Peach."},"children":[]}]}]}],"type":"boolean"},"isTransactional":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this interaction is considered \"transactional\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactional interactions are those which are sent via an automated system in response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to an event or some action taken. e.g., an email sent to confirm a payment was made is transactional;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"likewise an email sent to confirm a password change is transacrtional. Examples of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-transactional messages would be: those sent by an agent in response to a customer request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for collections, or for marketing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's important to mark these messages correctly, because different laws may apply to messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depending on if they're considered \"transactional\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for interactions sent before the transactional-ness was added to the API."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"lastTaskMeta":{"description":"The last task that was terminated (completed or canceled) for this interaction.\n","nullable":true,"properties":{"assignedEmployee":{"properties":{"firstName":{"description":"The first name of the employee which was assigned to this task.\n","nullable":true,"type":"string"},"id":{"description":"The ID of the employee which was assigned to this task.\n","nullable":true,"type":"string"},"lastName":{"description":"The last name of the employee which was assigned to this task.\n","nullable":true,"type":"string"},"userId":{"description":"The ID of the user of the employee which was assigned to this task.\n","nullable":true,"type":"string"}},"type":"object"},"assignmentStatus":{"description":"The status of the task assignment.\n","enum":["completed","canceled"],"type":"string"},"sid":{"description":"The SID of the task","type":"string"},"taskInitAt":{"description":"The time the task was originally created. (If an original task was marked as \"Unable to Complete\",\nand a new task was created, this will be the time of the original task.)\n","format":"date-time","type":"string"},"taskType":{"$ref":"#/components/schemas/TaskType"}},"type":"object"},"loanId":{"$ref":"#/components/schemas/AssociatedLoanId"},"loanIds":{"$ref":"#/components/schemas/AssociatedLoanIds"},"object":{"default":"interaction","enum":["interaction"],"readOnly":true,"type":"string"},"personId":{"description":"The ID of the borrower to which this interaction is associated","nullable":true,"type":"string"},"previousInteractionId":{"description":"If a previous interaction identifier is provided, the current and\nprevious interactions will be linked. This can either be Peach's or a lender's\nexternal identifier.\n","nullable":true,"type":"string"},"sendAt":{"description":"If set, records the time that the associated notification was Scheduled\nto be sent.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"sensitive":{"default":false,"description":"Set this flag if this interaction has sensitive information. The flag\nis used for proper authorization of access to the information.\n","nullable":true,"type":"boolean"},"sensitiveBorrowerOnly":{"default":false,"nullable":true,"readOnly":true,"type":"boolean"},"statusDetailsUpdatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime of the last "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statusDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"statusUpdatedAt":{"description":"The time of a status update.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"supercaseBulkOperationId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SupercaseBulkOperation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created this interaction, this is that ID"},"children":[]}]}]}],"nullable":true,"readOnly":true,"type":"string"},"templateVersionId":{"description":"Peach internal template identifier that was used to render the interaction.","nullable":true,"readOnly":true,"type":"string"},"twilioErrorCode":{"description":"Raw error code from Twilio SMS service. The full list of codes\ncan be found at https://www.twilio.com/docs/api/errors .\n","maxLength":10,"nullable":true,"type":"string"}},"type":"object"}],"title":"BaseInteraction"}},"components/schemas/GenericInteraction":{"id":"components/schemas/GenericInteraction","kind":"json-schema","title":"GenericInteraction","data":{"allOf":[{"properties":{"channel":{"description":"The channel by which an interaction occurs.\n","enum":["fax","gui","document"],"type":"string"},"content":{"description":"The content and attributes of the message sent. Normally in JSON format.","nullable":true,"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"GenericInteraction"}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An E.164 formatted phone number—a phone number prefixed with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a country code. (Note that in the United States this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"+12024561111","type":"string"}},"components/schemas/VoiceInteraction":{"id":"components/schemas/VoiceInteraction","kind":"json-schema","title":"VoiceInteraction","data":{"allOf":[{"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel by which an interaction occurs—always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VoiceInteraction"},"children":[]}]}]}],"enum":["voice"],"type":"string"},"content":{"properties":{"from":{"$ref":"#/components/schemas/PhoneNumber"},"to":{"$ref":"#/components/schemas/PhoneNumber"}},"type":"object"},"holdDuration":{"default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of time the inbound caller was on hold before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"speaking to an agent, in seconds. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the caller wasn't on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hold."},"children":[]}]}]}],"nullable":true,"type":"number"},"inboundCallAcceptedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for accepting the inbound call task.\n"},"isAutodialed":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if an autodialed call. If no value is passed, we'll assume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isAutodialed="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—meaning a manual call was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on why this is important reference the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telephone Consumer Protection Act (TCPA)."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"recordingConsentGiven":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower has given consent to record the call."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"recordingDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the recording of this voice call in seconds, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no recording."},"children":[]}]}]}],"nullable":true,"type":"integer"},"recordingStartedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date-time at which the recording of this voice call started, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if there is no recording."},"children":[]}]}]}],"format":"date-time","nullable":true,"type":"string"},"twilioConferenceFriendlyName":{"description":"The Twilio conference friendly name for this voice interaction.\n","nullable":true,"type":"string"},"twilioConferenceSid":{"description":"The Twilio conference SID for this voice interaction.\n","nullable":true,"type":"string"},"voicemailDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the voicemail of this voice call in seconds, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no voicemail."},"children":[]}]}]}],"nullable":true,"type":"integer"},"voicemailStartedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date-time at which the voicemail left for this call started, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if there is no voicemail."},"children":[]}]}]}],"format":"date-time","nullable":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"VoiceInteraction"}},"components/schemas/EmailObj":{"id":"components/schemas/EmailObj","kind":"json-schema","title":"EmailObj","data":{"description":"Email information","properties":{"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address—must include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email must be formatted like the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abby@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—it cannot be like the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Abby Doe <abby@example.com>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name associated with the email address","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/EmailInteraction":{"id":"components/schemas/EmailInteraction","kind":"json-schema","title":"EmailInteraction","data":{"allOf":[{"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel by which an interaction occurs—always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EmailInteraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["email"],"type":"string"},"content":{"properties":{"content":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the interaction is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the requesting user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not have permission to read sensitive content."},"children":[]}]}]}],"items":{"anyOf":[{"properties":{"type":{"enum":["text/html"],"type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTML body of the email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The HTML content of the email could be received from untrusted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sources. Caution should be used rendering it into a webpage. The data should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be sanitized and/or escaped. See https://owasp.org/www-community/attacks/xss/."},"children":[]}]}]}],"type":"string"}},"title":"HTML email body","type":"object"},{"properties":{"type":{"enum":["text/plain"],"type":"string"},"value":{"description":"The plain text of the email body.\n","type":"string"}},"title":"Plain text email body","type":"object"}]},"nullable":true,"type":"array"},"from":{"allOf":[{"description":"The email information of the sender","type":"object"},{"$ref":"#/components/schemas/EmailObj"}]},"personalizations":{"items":{"properties":{"bcc":{"items":{"$ref":"#/components/schemas/EmailObj"},"type":"array"},"cc":{"items":{"$ref":"#/components/schemas/EmailObj"},"type":"array"},"to":{"items":{"$ref":"#/components/schemas/EmailObj"},"type":"array"}},"type":"object"},"type":"array"},"subject":{"description":"The subject of the email.","type":"string"}},"type":"object"},"emailInReplyTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contents of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"In-Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the unique "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc5322.html#section-3.6.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC5322"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the email being replied to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wasn't present in the email."},"children":[]}]}]}],"nullable":true,"type":"string"},"emailMessageId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contents of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the unique "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc5322.html#section-3.6.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC5322"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with this email. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the header wasn't present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the email."},"children":[]}]}]}],"nullable":true,"type":"string"},"emailReferences":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contents of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"References"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, a structured string of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc5322.html#section-3.6.4"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC5322 email message"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identify the messages making up the email thread. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header wasn't present in the email."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"EmailInteraction"}},"components/schemas/ConvoMessage":{"id":"components/schemas/ConvoMessage","kind":"json-schema","title":"Conversation Message","data":{"properties":{"author":{"type":"string"},"body":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","type":"string"},"participant_sid":{"description":"SID of the participant that sent the message","type":"string"},"sent_with_attachments":{"type":"boolean"},"sid":{"description":"SID of the message","type":"string"}},"title":"Conversation Message","type":"object"}},"components/schemas/TextConvoParticipant":{"id":"components/schemas/TextConvoParticipant","kind":"json-schema","title":"Text Conversation Participant","data":{"properties":{"attributes":{"properties":{"borrowerId":{"description":"If this is a borrower participant, the borrower ID of the borrower.","nullable":true,"type":"string"},"contactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webchat type participants."},"children":[]}]}]}],"nullable":true,"type":"string"},"employeeId":{"description":"If this is an employee participant, the employee ID of the employee.","nullable":true,"type":"string"}},"type":"object"},"identity":{"description":"A unique string tracking the user in the Twilio chat system","type":"string"},"messaging_binding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webchat type participants."},"children":[]}]}]}],"nullable":true,"type":"object"},"sid":{"description":"The SID of the participant","type":"string"}},"title":"Text Conversation Participant","type":"object"}},"components/schemas/TextInteraction":{"id":"components/schemas/TextInteraction","kind":"json-schema","title":"TextInteraction","data":{"allOf":[{"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel by which an interaction occurs—always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for `TextInteraction``."},"children":[]}]}]}],"enum":["text"],"type":"string"},"content":{"anyOf":[{"nullable":true,"properties":{"body":{"description":"Body of the text message","type":"string"},"from":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/PhoneNumber"}]},"from_name":{"description":"Name of the text sender","nullable":true,"type":"string"},"to":{"$ref":"#/components/schemas/PhoneNumber"}},"title":"Outbound text interactions","type":"object"},{"nullable":true,"properties":{"messages":{"items":{"$ref":"#/components/schemas/ConvoMessage"},"type":"array"},"participants":{"additionalProperties":{"$ref":"#/components/schemas/TextConvoParticipant"},"description":"Each \"property name\" of this object is a participant SID and each value is an object\ndescribing the participant.\n","type":"object"}},"title":"Inbound text interactions","type":"object"}]},"twilioConvoSid":{"description":"The Twilio conversation SID associated with this interaction. (Only valid for interactions with a channel of text or chat)\n","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"TextInteraction"}},"components/schemas/ChatConvoParticipant":{"id":"components/schemas/ChatConvoParticipant","kind":"json-schema","title":"Webchat Conversation Participant","data":{"properties":{"attributes":{"properties":{"borrowerId":{"description":"If this is a borrower participant, the borrower ID of the borrower.","nullable":true,"type":"string"},"contactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webchat type participants."},"children":[]}]}]}],"nullable":true,"type":"string"},"employeeId":{"description":"If this is an employee participant, the employee ID of the employee.","nullable":true,"type":"string"}},"type":"object"},"identity":{"description":"A unique string tracking the user in the Twilio chat system","type":"string"},"messaging_binding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webchat type participants."},"children":[]}]}]}],"nullable":true,"type":"object"},"sid":{"description":"The SID of the participant","type":"string"}},"title":"Webchat Conversation Participant","type":"object"}},"components/schemas/ChatInteraction":{"id":"components/schemas/ChatInteraction","kind":"json-schema","title":"ChatInteraction","data":{"allOf":[{"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel by which an interaction occurs—always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChatInteraction"},"children":[]}]}]}],"enum":["chat"],"type":"string"},"content":{"nullable":true,"properties":{"messages":{"items":{"$ref":"#/components/schemas/ConvoMessage"},"type":"array"},"participants":{"additionalProperties":{"$ref":"#/components/schemas/ChatConvoParticipant"},"description":"Each key of this object is a participant SID and each value is an object\ndescribing the participant.\n","type":"object"}},"type":"object"},"twilioConvoSid":{"description":"The Twilio conversation SID associated with this interaction. (Only valid for interactions with a channel of text or chat)\n","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"ChatInteraction"}},"components/schemas/MailInteraction":{"id":"components/schemas/MailInteraction","kind":"json-schema","title":"MailInteraction","data":{"allOf":[{"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel by which an interaction occurs—always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MailInteraction"},"children":[]}]}]}],"enum":["mail"],"type":"string"},"mailIsCertified":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not this mail interaction is sent as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://faq.usps.com/s/article/Certified-Mail-The-Basics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS Certified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Certified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mail provides proof of mailing and has more granular tracking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"events, but incurs additional cost. Please refer to your order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form for more pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: Sending as certified mail is currently only supported for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the following subjects:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecured"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredColorado"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredDC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredIowa"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredKansas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredMaine"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredMissouri"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredSouthCarolina"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredWestVirginia"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRightToCurePersonalUnsecuredWisconsin"},"children":[]}]}]}]}],"type":"boolean"},"mailNumberOfPages":{"nullable":true,"type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/BaseInteraction"}],"title":"MailInteraction"}},"components/schemas/Interaction":{"id":"components/schemas/Interaction","kind":"json-schema","title":"Interaction","data":{"anyOf":[{"$ref":"#/components/schemas/GenericInteraction"},{"$ref":"#/components/schemas/VoiceInteraction"},{"$ref":"#/components/schemas/EmailInteraction"},{"$ref":"#/components/schemas/TextInteraction"},{"$ref":"#/components/schemas/ChatInteraction"},{"$ref":"#/components/schemas/MailInteraction"}]}},"components/schemas/CompanyAppDomain":{"id":"components/schemas/CompanyAppDomain","kind":"json-schema","title":"CompanyAppDomain","data":{"properties":{"companyId":{"description":"The company ID","readOnly":true,"type":"string"},"domain":{"description":"The company app domain","type":"string"},"id":{"description":"The app domain ID","readOnly":true,"type":"string"},"type":{"enum":["borrower","agent","help","admin"],"type":"string"}},"type":"object"}},"components/schemas/CompanyConfigSamlAuth":{"id":"components/schemas/CompanyConfigSamlAuth","kind":"json-schema","title":"CompanyConfigSamlAuth","data":{"properties":{"metadataUrl":{"oneOf":[{"description":"The metadata URL to use for all SAML authentication","example":"https://example.com/app123/samlmetadata","type":"string"},{"additionalProperties":false,"properties":{"admin":{"description":"The metadata URL for the admin login SAML authentication","example":"https://example.com/federationmetadata.xml?appid=123","type":"string"},"agent":{"description":"The metadata URL for the agent login SAML authentication","type":"string"},"borrower":{"description":"The metadata URL for the borrower login SAML authentication","example":"https://example.com/federationmetadata.xml?appid=234","type":"string"}},"type":"object"}]},"nameIdFormat":{"type":"string"}},"type":"object"}},"components/schemas/CompanyConfigBorrowerVerification":{"id":"components/schemas/CompanyConfigBorrowerVerification","kind":"json-schema","title":"CompanyConfigBorrowerVerification","data":{"properties":{"crmDefaultTypeId":{"description":"The ID of the borrower verification type used when an agent initiates a borrower verification via the CRM.\nThe borrower verification type is the configuration which specifies how many of a particular type of verification question to ask when an agent verifies a borrower's identity.","example":"VT-1234-ABDE","type":"string"}},"type":"object"}},"components/schemas/CompanyConfigCollections":{"id":"components/schemas/CompanyConfigCollections","kind":"json-schema","title":"CompanyConfigCollections","data":{"properties":{"autoClose":{"properties":{"closeOnlyWhenPaidOff":{"default":false,"description":"If true, keep the collection case open even when the overdue loan is charged off or frozen.","type":"boolean"},"enabled":{"default":false,"type":"boolean"}},"type":"object"},"autoInitiate":{"properties":{"collectionCaseTypeId":{"description":"Public ID of the case type to be used when creating a new collection case.","type":"string"},"enableReviewTask":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, when a collection case is created automatically, a task of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewAutoCreatedCase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is created in taskrouter—the assumption being that usually a human should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"review automatically created cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable the creation of this task set this config to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"enabled":{"default":false,"type":"boolean"},"inspectionProcName":{"description":"The name of the inspection procedure to run on the borrower's account.","type":"string"},"interactionDaysPassedThreshold":{"description":"Number of days to wait after the last loan overdue notification\nwas sent. The number depends on the loan's due dates frequency.\n","properties":{"everyTwoWeeks":{"type":"integer"},"monthly":{"type":"integer"},"twiceMonthly":{"type":"integer"},"weekly":{"type":"integer"}},"type":"object"},"loanDaysOverdueThreshold":{"description":"Number of days to wait before creating a new collection case.\nThe number depends on the loan's due dates frequency.\n","properties":{"everyTwoWeeks":{"type":"integer"},"monthly":{"type":"integer"},"twiceMonthly":{"type":"integer"},"weekly":{"type":"integer"}},"type":"object"},"nOverdueNoticesRequired":{"description":"The number of different loan overdue notices required to be sent\nbefore a new collection case is created.\n","type":"integer"},"nPastCollectionsThreshold":{"description":"Create a collection case if the number of past collections exceeds\nthis number.\n","type":"integer"},"totalOverdueAmountThreshold":{"description":"The sum of overdue amounts of all overdue loans has to exceed this\nvalue for the collection case to be created.\n","type":"integer"}},"type":"object"},"intensityLimits":{"additionalProperties":{"properties":{"heavy":{"type":"integer"},"light":{"type":"integer"},"normal":{"type":"integer"}},"type":"object"},"description":"Keys are strings where each number is a period in days","type":"object"}},"type":"object"}},"components/schemas/CompanyConfigDataAccess":{"id":"components/schemas/CompanyConfigDataAccess","kind":"json-schema","title":"Company Config Data Access","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who may access this company's data, where the restriction comes from the company's contract"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rather than from the permission model. Peach's permission model has no company dimension on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cross-company access, so a restriction like this cannot be expressed as a permission — it has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be recorded here and honored by whatever provisions access."},"children":[]}]}]}],"properties":{"contractorAccessAllowed":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether contractors may be granted access to this company. This is an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allow-list"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the field is unset on a company until someone decides, and an unset company is treated as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT allowed. Leaving it unset is therefore safe — it withholds access rather than granting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it — so a lender signed under a contract that forbids non-employee access is protected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"even if nobody remembers to record anything."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tools/create_employee_with_api_key.py"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ensure-contractor-roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create --contractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync-contractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which provisions per-company contractor roles"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only on companies where this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync-contractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports companies with no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decision recorded so they can be resolved deliberately rather than defaulted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because it is read at provisioning time, setting it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a company a contractor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" been granted does not revoke that access. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync-contractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports it as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy violation; the grant must be removed with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /companies/{companyId}/users/{userId}/roles/{roleId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /companies/{companyId}/config?paths=dataAccess.contractorAccessAllowed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"title":"Company Config Data Access","type":"object"}},"components/schemas/CompanyConfigDataOutbox":{"id":"components/schemas/CompanyConfigDataOutbox","kind":"json-schema","title":"CompanyConfigDataOutbox","data":{"properties":{"compressionFormat":{"default":"gzip","description":"Compression format of files delivered.\n","enum":["gzip","snappy"],"type":"string"},"deliveryFrequency":{"default":"1h","description":"Frequency of data deliveries.\n","enum":["15m","1h","1d"],"type":"string"},"destinationBucket":{"description":"The name of the bucket to use for data outbox.\n","type":"string"},"destinationProvider":{"default":"gcp","description":"The provider of the bucket to use for data outbox.\n","enum":["gcp","aws","azure"],"type":"string"},"destinationRegion":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The region of the bucket to use for data outbox. This is only required if the destination provider is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aws"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"fileFormat":{"default":"parquet","description":"Format of files delivered. Currently, only Parquet is supported.\n","enum":["parquet","avro"],"type":"string"},"googleServiceAccount":{"description":"The Google Cloud service account to use for data outbox.\n","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/CompanyConfigMonitoring":{"id":"components/schemas/CompanyConfigMonitoring","kind":"json-schema","title":"CompanyConfigMonitoring","data":{"properties":{"criteria":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria used to determine whether monitoring should be enabled for a borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitoring will be enabled:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": if the borrower "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerAndLoanStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": if the borrower "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the borrower has loans with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]}]}],"enum":["borrowerStatus","borrowerAndLoanStatus"],"type":"string"},"scraCaseCreationCriteria":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria used to determine whether a SCRA case should be created for a borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A SCRA case will be created:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Upon borrower identity match, SCRA case will be created even if there are no loans that are qualified per"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCRA regs. If there are eligible loans, the case will associate them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerAndLoan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Upon borrower identity match, SCRA case will be created only if there are qualified loans per SCRA regs."},"children":[]}]}]}]}],"enum":["borrowerOnly","borrowerAndLoan"],"type":"string"}},"type":"object"}},"components/schemas/CompanyConfigPaymentExternalTransaction":{"id":"components/schemas/CompanyConfigPaymentExternalTransaction","kind":"json-schema","title":"CompanyConfigPaymentExternalTransaction","data":{"properties":{"statusTransition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables lenders to control whether Peach's system will automatically intervene and transition the status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transitionLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach's system will automatically transition "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a specified period of time as defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalTransactions.transitionLogic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Lender is responsible for transitioning the status of external transactions via API."},"children":[]}]}]}]}],"enum":["auto","manual"],"type":"string"},"transactionType":{"enum":["ach","debitCard","creditCard","check","payroll","moneyOrder","wire","paymentNetwork"],"type":"string"},"transitionLogic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for statusTransition = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defines the logic used to determine when the external transaction's status will transition from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", assuming no other status changes occur in the meantime."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numDays`` - Peach's system will wait a specified amount of time in order to automatically transition the status of the transaction from "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"succeeded`."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": any transactions whose status is not pending will be excluded from the logic to automatically transition the status of a payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDays`` - Peach's system will adhere to the holdDaysEndDate on the transaction and automatically transition the status of the transaction from "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at the end of the hold day period. **NOTE**: Peach will only transition transactions with status ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending`."},"children":[]}]}]}]}]}],"properties":{"dayType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines whether the system should calculate the automatic status transition based on calendar or business days. NOTE: this is a required attribute for products whose statusTransition is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" AND the transitionLogic is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value cannot be set when type=holdDays."},"children":[]}]}]}],"enum":["calendar","business"],"type":"string"},"numDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how many days the system will wait to automatically update the transaction's status if transitionLogic.type = numDays."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value cannot be set when transitionLogic.type="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will transition the status of the transaction on the Nth day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a transaction is created on Jan 1 and numDays = 3, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction's status will automatically transition on Jan 4."},"children":[]}]}]}],"type":"integer"},"type":{"enum":["numDays","holdDays"],"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/CompanyConfigTasks":{"id":"components/schemas/CompanyConfigTasks","kind":"json-schema","title":"CompanyConfigTasks","data":{"properties":{"channelCapacities":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capacity configured for each task for channel type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default capacity for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., tasks without a channel)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]}]}]}]}],"properties":{"chat":{"minimum":0,"nullable":true,"type":"integer"},"default":{"minimum":0,"nullable":true,"type":"integer"},"email":{"minimum":0,"nullable":true,"type":"integer"},"text":{"minimum":0,"nullable":true,"type":"integer"},"voice":{"minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"disableTaskRouter":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disable all task routing features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i.e., Agents will not log in to task system. Tasks will not be created."},"children":[]}]}]}],"type":"boolean"},"disableTaskTypes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of task types to disable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a task type is disabled the system functions as normal except no task"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that some task types which are allowed to be disabled here probably would be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"better served disabled elsewhere. For instance, disabling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"answerInboundVoiceCall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"would mean that incoming voice calls are still able to be received by the Peach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system, but cannot be answered by agents! In this case, it would be better to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set the config "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communication.enableInboundVoiceCall=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaskType"},"type":"array"},"enableCaseOwnership":{"description":"Enable optionally assigning an owner to Case objects. This will be\nused during task routing to prefer to match tasks relating to cases\nwith their owners.\n","type":"boolean"}},"type":"object"}},"components/schemas/CompanyConfigWebhooks":{"id":"components/schemas/CompanyConfigWebhooks","kind":"json-schema","title":"CompanyConfigWebhooks","data":{"properties":{"requestTimeoutSeconds":{"description":"The number of seconds the system will wait for a response\nfrom a webhook before timing out.\n","maximum":300,"minimum":30,"nullable":true,"type":"integer"}},"type":"object"}},"components/schemas/CompanyConfigZendeskSSO":{"id":"components/schemas/CompanyConfigZendeskSSO","kind":"json-schema","title":"CompanyConfigZendeskSSO","data":{"properties":{"sso":{"properties":{"enabled":{"type":"boolean"},"sharedSecretToken":{"description":"The shared secret token.","type":"string"},"subdomain":{"description":"Subdomain of the remote log in URL.","type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/CompanyConfig":{"id":"components/schemas/CompanyConfig","kind":"json-schema","title":"Company Config","data":{"description":"The company configuration object is the main location to store configuration\nsettings to control the functionality and appearance of the Peach\napplications which this company users.\n","properties":{"addressValidation":{"default":"smartyStreets","description":"Vendor to use for address validation.","enum":["smartyStreets","googleMaps"],"type":"string"},"allowPartialAddress":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Address Line 1 is Optional, otherwise it is required for loans managed by Peach"},"children":[]}]}]}],"type":"boolean"},"auth":{"properties":{"saml":{"$ref":"#/components/schemas/CompanyConfigSamlAuth"}},"type":"object"},"borrowerVerification":{"$ref":"#/components/schemas/CompanyConfigBorrowerVerification"},"brandAssets":{"$ref":"#/components/schemas/CompanyConfigBrandAssets","nullable":true},"collections":{"$ref":"#/components/schemas/CompanyConfigCollections"},"communication":{"$ref":"#/components/schemas/CompanyConfigCommunication","nullable":true},"compliance":{"description":"Compliance guard related configuration parameters","properties":{"no_review_task_for_autocreated_cases":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then assume that cases automatically created via Compliance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guard do not need to be reviewed by a human. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or unset, then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whenever Compliance Guard automatically creates a case, create a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponding task for an agent to review the newly created case."},"children":[]}]}]}],"type":"boolean"},"no_review_task_for_autoupdated_cases":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then assume that cases automatically updated via Compliance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guard do not need to be reviewed by a human. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or unset, then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whenever Compliance Guard automatically updates certain cases, create a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponding task for an agent to review the updated case."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only a subset of automatically updated cases will generate a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"review task even with this setting enabled. Those are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"militaryDuty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"rndCompanyId":{"description":"Reassigned Numbers Database Company ID","type":"string"}},"type":"object"},"creditCounselingServicesNumber":{"type":"string"},"dataAccess":{"$ref":"#/components/schemas/CompanyConfigDataAccess"},"dataOutbox":{"$ref":"#/components/schemas/CompanyConfigDataOutbox"},"documents":{"description":"Document processing related configuration parameters.","properties":{"signer_contact":{"description":"Signer's contact information to be added to the signature.","type":"string"},"signer_location":{"description":"Signer's location (e.g. \"Oakland, CA, USA\")","type":"string"},"signing_key":{"description":"Document signing key in PKCS 12 format.","type":"string"},"signing_key_password_token":{"description":"Token corresponding to the signing key password.","type":"string"}},"type":"object"},"evidence":{"$ref":"#/components/schemas/CompanyConfigEvidence"},"forceCaseIdOnAgentActions":{"default":true,"description":"If true, a loan action made by an agent must come with a case ID.","type":"boolean"},"links":{"$ref":"#/components/schemas/CompanyConfigLinks","nullable":true},"monitoring":{"$ref":"#/components/schemas/CompanyConfigMonitoring"},"openHours":{"$ref":"#/components/schemas/CompanyConfigOpenHours","nullable":true},"payment":{"description":"Payment processing configuration.","properties":{"allowedCreditCardTx":{"description":"Controls how credit cards can be used.","properties":{"downPayment":{"default":true,"description":"If true, down payments are allowed with credit cards.","type":"boolean"},"payment":{"default":false,"description":"If true, regular loan payments are allowed with credit cards.","type":"boolean"}},"type":"object"},"bypassCollisionCheck":{"description":"Allow the creation of multiple payment instruments with the same details within the same company.","type":"boolean"},"disablePaymentProcessing":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will not process payments or allow creation of transactions where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing internal transactions will be canceled on their scheduled date. Lenders can continue to create and process external transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleAutopayTransactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control whether external autopay transactions will automatically be created by Peach."},"children":[]}]}]}],"type":"boolean"},"externalTransactions":{"description":"Enables lenders to configure treatment of external transactions by Peach's system.\n","items":{"$ref":"#/components/schemas/CompanyConfigPaymentExternalTransaction"},"type":"array"},"maxNumberNewPaymentMethodsIn30Days":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a borrower has created a Payment Instrument this many times in the past 30 days,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they will be blocked from creating anymore. This does not apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instruments, or instruments created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"processedByPeach":{"description":"Whether Peach handles payment processing for this company.","type":"boolean"},"scheduleAutopayTransactions":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processedByPeach=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will create transactions in scheduled status based on Autopay plan expected payments (aka AEPs)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will not create Autopay transactions based on Autopay plan expected payments. In this case, the lender is expected to create applicable transactions."},"children":[]}]}]}],"type":"boolean"},"transactionLimitAmount":{"default":100000,"description":"Maximum amount for a single transaction","type":"integer"}},"type":"object"},"paymentTypes":{"$ref":"#/components/schemas/CompanyConfigPaymentTypes"},"requireBorrowerIdentity":{"default":true,"description":"Require new borrowers to have identity information.","type":"boolean"},"search":{"properties":{"indexing":{"properties":{"enabled":{"default":true,"description":"If false, data will not be indexed in elastic search","type":"boolean"}},"type":"object"}},"type":"object"},"statements":{"$ref":"#/components/schemas/CompanyConfigStatements"},"support":{"$ref":"#/components/schemas/CompanyConfigSupport","nullable":true},"tasks":{"$ref":"#/components/schemas/CompanyConfigTasks"},"timezone":{"$ref":"#/components/schemas/CompanyConfigTimezone","nullable":true},"ui":{"$ref":"#/components/schemas/CompanyConfigUi","nullable":true},"webhooks":{"$ref":"#/components/schemas/CompanyConfigWebhooks"},"zendesk":{"$ref":"#/components/schemas/CompanyConfigZendeskSSO"}},"title":"Company Config","type":"object"}},"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"agentAuthType":{"$ref":"#/components/schemas/AuthType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of agent authentication, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]}]}]}]},"agentAuthValueType":{"$ref":"#/components/schemas/AuthValueType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType=basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., user/password authentication), require this method of authentication (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"appDomains":{"items":{"$ref":"#/components/schemas/CompanyAppDomain"},"type":"array"},"bankruptcyPolicy":{"type":"boolean"},"bankruptcyServiceId":{"description":"The service that will be used for bankruptcy monitoring (no monitoring if is null)","type":"integer"},"borrowerAuthType":{"$ref":"#/components/schemas/AuthType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of borrower authentication, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]}]}]}]},"borrowerAuthValueType":{"$ref":"#/components/schemas/AuthValueType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType=basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., user/password authentication), require this method of authentication (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"brandName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for presentation to the end consumer—e.g., in emails."},"children":[]}]}]}],"nullable":true,"type":"string"},"config":{"$ref":"#/components/schemas/CompanyConfig"},"deceasedPolicy":{"type":"boolean"},"deceasedServiceId":{"description":"The service that will be used for deceased monitoring (no monitoring if is null)","type":"integer"},"domainName":{"description":"Base web domain being used in communications/email/etc","type":"string"},"femaPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", automatically create Supercases when a disaster is detected in the region"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a borrower's address."},"children":[]}]}]}],"type":"boolean"},"femaServiceId":{"description":"The service that will be used for FEMA disaster monitoring (no monitoring if is null)","type":"integer"},"legalName":{"description":"Legal name of the company","type":"string"},"name":{"description":"Alternate name for the company","type":"string"},"object":{"enum":["company"],"readOnly":true,"type":"string"},"ofacServiceId":{"description":"The service that will be used for OFAC monitoring (no monitoring if is null)","type":"integer"},"rndServiceId":{"description":"The service that will be used for OFAC monitoring (no monitoring if is null)","type":"integer"},"scraServiceId":{"description":"The service that will be used for SCRA military monitoring (no monitoring if is null)","type":"integer"},"shortDomainName":{"description":"Base web domain being used in communications/email/etc","type":"string"},"slug":{"description":"A slug to be used to match this company in other environments (dev/sandbox/etc).\nIt will also be used for FE hosting and the default DNS entries created for it.\n","maxLength":50,"minLength":1,"type":"string"},"status":{"default":"active","description":"The status of the company.","enum":["active","activeChurning","inactive"],"type":"string"},"timezone":{"$ref":"#/components/schemas/CompanyConfigTimezone","nullable":true},"tokenizationKeyId":{"type":"integer"},"type":{"description":"Type enumerator for companies","type":"string"}},"type":"object"}],"description":"The company object represents a company of Peach which uses some of Peach's applications.\n\nIt contains metadata about the company and configuration settings for how the applications\nshould function.\n"}},"components/schemas/BaseMixinWithoutTimestamps":{"id":"components/schemas/BaseMixinWithoutTimestamps","kind":"json-schema","title":"BaseMixinWithoutTimestamps","data":{"properties":{"id":{"readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/PersonType":{"id":"components/schemas/PersonType","kind":"json-schema","title":"PersonType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A relation type between a borrower and a loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the value if there are two or more borrowers."},"children":[]}]}]}],"enum":["coBorrower","coSigner","applicant"],"type":"string"}},"components/schemas/CancellationReason":{"id":"components/schemas/CancellationReason","kind":"json-schema","title":"CancellationReason","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"technicalIssue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created due to a technical issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wrongLoanTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created with the wrong terms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wrongBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created on the wrong borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - for any other reason requiring cancellation."},"children":[]}]}]}],"enum":["technicalIssue","wrongLoanTerms","wrongBorrower","other"],"type":"string"}},"components/schemas/LoanLabel":{"id":"components/schemas/LoanLabel","kind":"json-schema","title":"LoanLabel","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"description":{"description":"An optional description of the loan label. Typically used to store additional details or\nan explanation about the label. Not displayed in any user interfaces.\n","type":"string"},"name":{"description":"The name of the label. This is the name that will appear in the agent (and admin, if applicable) portals.\n","type":"string"}},"type":"object"}]}},"components/schemas/BaseLoanMixin":{"id":"components/schemas/BaseLoanMixin","kind":"json-schema","title":"BaseLoanMixin","data":{"properties":{"additionalBorrowers":{"items":{"properties":{"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The borrower's external ID if this related borrower has one, otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"readOnly":true,"type":"string"},"id":{"description":"ID of the related borrower","type":"string"},"name":{"description":"The related borrower's full name (or business's name if this is a business).","readOnly":true,"type":"string"},"relationType":{"$ref":"#/components/schemas/PersonType"}},"type":"object"},"nullable":true,"type":"array"},"assetDisplayName":{"description":"The asset display name. For example: Loan, Line of Credit, Lease, Credit Card.\n","readOnly":true,"type":"string"},"cancellationReason":{"allOf":[{"$ref":"#/components/schemas/CancellationReason","nullable":true},{"readOnly":true}]},"declineReason":{"description":"The reason(s) why the loan application or the draw request was declined.","nullable":true,"properties":{"mainExternalReasonCode":{"description":"A Lender's external main decline reason code.","type":"string"},"mainScriptForRep":{"description":"The main decline reason script that a customer service agent can provide to the borrower.","type":"string"},"mainText":{"description":"The main decline reason text that was shown to the borrower.","type":"string"},"subReasons":{"items":{"properties":{"externalReasonCode":{"description":"A Lender's external decline reason code.","type":"string"},"reasonText":{"description":"The decline reason text that was shown to the borrower.","type":"string"},"scriptForRep":{"description":"The decline reason script that a customer service agent can provide to the borrower.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"displayId":{"description":"The loan ID to show in the UI (Peach public or external).","readOnly":true,"type":"string"},"endDate":{"description":"The end date of the loan in the product timezone, if amortized.","format":"date","nullable":true,"readOnly":true,"type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for a loan or a draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"minLength":1,"nullable":true,"type":"string"},"labels":{"items":{"$ref":"#/components/schemas/LoanLabel"},"readOnly":true,"type":"array"},"metaData":{"$ref":"#/components/schemas/MetaData"},"timestamps":{"description":"Various loan timestamps.","properties":{"acceleratedAt":{"description":"The timestamp of the effective date of the acceleration of a loan or draw. A\npreviously accelerated loan that has been reversed will be marked as null.\n","format":"date-time","nullable":true,"type":"string"},"activatedAt":{"description":"The timestamp when the loan or the draw was activated.","format":"date-time","nullable":true,"type":"string"},"canceledAt":{"description":"The timestamp of when the loan was canceled","format":"date-time","nullable":true,"type":"string"},"chargedOffAt":{"description":"The timestamp of the effective date of the charge-off of a loan or draw. A\npreviously accelerated loan that has been reversed will be marked as null.\n","format":"date-time","nullable":true,"type":"string"},"closedAt":{"description":"The date LOC or Draw was closed.","format":"date-time","nullable":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"frozenAt":{"description":"The timestamp of the most recent freeze date of a loan or draw. A previously frozen\nloan that has been reversed will be marked as null.\n","format":"date-time","nullable":true,"type":"string"},"lastAmortizedAt":{"description":"The most recent date when the loan or the draw was amortized. Due dates schedule change\ncan cause to re-amortization.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"migratedAt":{"description":"The timestamp of when the loan completed loan migration.","format":"date-time","nullable":true,"type":"string"},"originatedAt":{"description":"The timestamp when the loan or draw was originated.","format":"date-time","nullable":true,"type":"string"},"paidOffAt":{"description":"The timestamp of the effective date when a loan or draw is paidOff.\n","format":"date-time","nullable":true,"type":"string"},"startedAt":{"description":"The timestamp when the loan or the draw was activated.","format":"date-time","nullable":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/OldConsumerAccountNumber":{"id":"components/schemas/OldConsumerAccountNumber","kind":"json-schema","title":"OldConsumerAccountNumber","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The old Account Number that was assigned to this account in the other system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(not Peach) prior to migration. The new Account Number that will be reported"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Peach Public ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not include embedded blanks or special characters. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeIndicator=2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field should be left empty or blank filled."},"children":[]}]}]}],"maxLength":30,"minLength":1,"nullable":false,"type":"string"}},"components/schemas/MigrationL2SegmentCANOnly":{"id":"components/schemas/MigrationL2SegmentCANOnly","kind":"json-schema","title":"MigrationL2SegmentCANOnly","data":{"properties":{"changeIndicator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The change indicator field."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Identification Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number AND Identification Number Change."},"children":[]}]}]}]}],"enum":["1"],"type":"string"},"oldConsumerAccountNumber":{"$ref":"#/components/schemas/OldConsumerAccountNumber"}},"required":["changeIndicator","oldConsumerAccountNumber"],"type":"object"}},"components/schemas/OldIdentificationNumber":{"id":"components/schemas/OldIdentificationNumber","kind":"json-schema","title":"OldIdentificationNumber","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The old Identification Number that was used in the other system (not Peach)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prior to migration. The new Identification Number that will be reported is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as configured in Peach."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not include embedded blanks or special characters. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeIndicator=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field should be left empty or blank filled."},"children":[]}]}]}],"maxLength":20,"minLength":1,"nullable":false,"type":"string"}},"components/schemas/MigrationL2SegmentIDNOnly":{"id":"components/schemas/MigrationL2SegmentIDNOnly","kind":"json-schema","title":"MigrationL2SegmentIDNOnly","data":{"properties":{"changeIndicator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The change indicator field."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Identification Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number AND Identification Number Change."},"children":[]}]}]}]}],"enum":["2"],"type":"string"},"oldIdentificationNumber":{"$ref":"#/components/schemas/OldIdentificationNumber"}},"required":["changeIndicator","oldIdentificationNumber"],"type":"object"}},"components/schemas/MigrationL2SegmentBoth":{"id":"components/schemas/MigrationL2SegmentBoth","kind":"json-schema","title":"MigrationL2SegmentBoth","data":{"nullable":true,"properties":{"changeIndicator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The change indicator field."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Identification Number Change ONLY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Consumer Account Number AND Identification Number Change."},"children":[]}]}]}]}],"enum":["3"],"type":"string"},"oldConsumerAccountNumber":{"$ref":"#/components/schemas/OldConsumerAccountNumber"},"oldIdentificationNumber":{"$ref":"#/components/schemas/OldIdentificationNumber"}},"required":["changeIndicator","oldConsumerAccountNumber","oldIdentificationNumber"],"type":"object"}},"components/schemas/MigrationL2Segment":{"id":"components/schemas/MigrationL2Segment","kind":"json-schema","title":"MigrationL2Segment","data":{"description":"The L1 Segment provides an automated method for changing the\nConsumer Account Number and/or Identification Number and should be\nreported only one time per record to affect the change.\n\nIf you migrate an account to Peach, and want to include the L1\nsegment, you need to pass all the applicable attributes in this\nobject.\n","discriminator":{"mapping":{"1":"#/components/schemas/MigrationL2SegmentCANOnly","2":"#/components/schemas/MigrationL2SegmentIDNOnly","3":"#/components/schemas/MigrationL2SegmentBoth"},"propertyName":"changeIndicator"},"oneOf":[{"$ref":"#/components/schemas/MigrationL2SegmentCANOnly"},{"$ref":"#/components/schemas/MigrationL2SegmentIDNOnly"},{"$ref":"#/components/schemas/MigrationL2SegmentBoth"}]}},"components/schemas/Migration":{"id":"components/schemas/Migration","kind":"json-schema","title":"Migration","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan migration details. This structure should be used for loans that are migrated from another system to Peach."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To migrate a loan (see migration guidance for full details):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. The loan must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before proceeding to the next step."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call relevant endpoints to create past payments, refunds, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Migrate loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"properties":{"activatedDate":{"description":"The activation date of the migrated loan in the product timezone. The date must be in the past.","format":"date","type":"string","writeOnly":true},"activatedTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone."},"children":[]}]}]}],"type":"object"}],"writeOnly":true},"creditReporting":{"additionalProperties":false,"description":"Instructions to the Peach system on how to report a migrated account.","properties":{"dateClosed":{"description":"Legacy-system date the account was closed. If provided, Peach uses this value for Metro2 \"Date Closed\"; otherwise Peach derives it from Peach close/payoff events.\n","format":"date","nullable":true,"type":"string"},"dateOfFirstDelinquency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of first delinquency as of the \"migration cutoff"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date\". This attribute is required to accurately report delinquency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data. If the migrated account is delinquent (based on the Metro2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"definition) or was delinquent in the past, then you must pass the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfFirstDelinquency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details of how to determine this value, please refer to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"most recent Metro2 Credit Reporting Resource Guide."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"k2Segment":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The K2 Segment may be used to report the name of the company from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which the account was purchased or the name of the company to which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the account was sold."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you migrate an account to Peach, and want to include the K2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segment, you need to pass all the applicable attributes in this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please review the notes below per the Metro2 Credit Reporting Resource Guide:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the company that purchased the accounts will not report the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prior history, the seller must report the accounts as sold to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reflect the final status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is delinquent or derogatory, it is imperative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that you provide the date of the first delinquency that led to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the account being sold to the debt purchaser."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the company that purchased the accounts is converting the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account history to their system, the seller should not report"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the accounts as sold. In this situation, the seller and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchaser should work together with the data representatives at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the consumer reporting agencies, who will assist you with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion of the accounts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the lender who sold the accounts reported them as \"purchased"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by another company\" or the history cannot be verified for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account prior to purchase, report the Base and K2 Segment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the new lender is unable to obtain the Date of First"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delinquency with the original lender, do not report the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment history that occurred with the previous lender, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is already on the consumer's file, must not be reported by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new lender."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the previous lender's account history is being converted to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the new lender's system and the account history can be verified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report the Base, K2 Segment and L1 Segment fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the new lender is unable to obtain the Date of First"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delinquency with the original lender, do not report the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to configure the Identification Number to be the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same as reported by the previous lender."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to pass loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the Account Number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reported by the previous lender."},"children":[]}]}]}]}]}]}]}],"nullable":true,"properties":{"purchasedFromName":{"description":"Contains the name of the company from which the account was purchased.","maxLength":30,"minLength":1,"type":"string"}},"required":["purchasedFromName"],"type":"object"},"l1Segment":{"$ref":"#/components/schemas/MigrationL2Segment"},"paymentHistoryProfile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment history profile of the account prior to the migration date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of this attribute is a string of exactly 24"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"characters. Peach will use the provided history profile of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account to report the history up to 24 months. After the migration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cutoff date, Peach will start reporting \"new/current\" payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"behavior and use part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentHistoryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration from date = Jan 11, 2022 (this is also a statement date)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentHistoryProfile = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000011000000EEEE0000BBBB"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data represents, from left to right, 12/31/2021 back through"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01/31/2020. The E's indicate that the account was current with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zero balance in 12/2020, 11/2020, 10/2020 and 09/2020. The B's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicate that no payment history was available prior to 05/2020,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which was most likely the date account was opened."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will first report the account on Feb 1, 2022:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of Account Information = 01/31/2022 (represents the reporting period of 01/01/2022 through 01/31/2022)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Status Code = 11"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will report the PHP field as is - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000011000000EEEE0000BBBB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will report the account again on Mar 1, 2022:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of Account Information = 02/31/2022 (represents the reporting period of 02/01/2022 through 02/28/2022)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach will use part of the original value passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentHistoryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and report the PHP field as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0000011000000EEEE0000BBB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that Peach didn't use the last \"B\" from the original value that was passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details of how to determine this value, please refer to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"most recent Metro2 Credit Reporting Resource Guide. The below was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"copied from the Metro2 2022 Credit Reporting Resource Guide:"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains up to 24 months of consecutive payment activity for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previous 24 reporting periods prior to the Date of Account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information (Field 24) being reported. Report one month's payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"history in each byte from the left to right in most recent to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"least recent order. The first byte should represent the Account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status Code reported in the previous reporting period. Refer to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exhibit 5 for examples of reporting payment history, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includes examples for month-end reporters, as well as examples"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for reporters who submit data on other days of the month (e.g.,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1st, 15th, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 0 payments past due (current account)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 30 - 59 days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 60 - 89 days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 90 - 119 days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 120 - 149 days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 150 - 179 days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 180 or more days past due date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = No payment history available prior to this time – either because the account was not open or because the payment history cannot be furnished. A \"B\" may not be embedded within other values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = No payment history reported/available this month. \"D\" may be embedded in the payment history profile."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Code \"D\" should not be used as a default value or reported to remove accurately-reported history."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Zero balance and Account Status 11 – Current (0-29 days past the due date)(Applies to Credit Cards and Lines of Credit)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Collection"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"H"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Foreclosure Completed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"J"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Voluntary Surrender"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"K"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Repossession"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"L"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Charge-off"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No other values are acceptable in this field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not provided, Peach will report PHP as \"unknown\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the \"activation date\" until the \"migration cutoff date\" using a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the Metro2 Credit Reporting Resource"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guide."},"children":[]}]}]}],"maxLength":24,"minLength":24,"nullable":true,"pattern":"^[0123456BDEGHJKL]{24}$","type":"string"}},"type":"object","writeOnly":true},"migrationStatus":{"default":"nonMigrated","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan migration status. This attribute can be updated by the Peach system only."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonMigrated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this is a non-migrated loan. Most loans are expected to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonMigrated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the lender can add objects to the loan in the past."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system is migrating the loan. Objects cannot be modified or added."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was successfully migrated. After a successful migration the loan status will be changed to one of the following statuses: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan migration attempt failed. The loan will remain in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. You can update the loan details and try to migrate again by calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Migrate loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"enum":["nonMigrated","prepMigration","migrating","completed","failed"],"type":"string"}},"title":"Migration","type":"object"}},"components/schemas/SharedInstallmentAndLoc":{"id":"components/schemas/SharedInstallmentAndLoc","kind":"json-schema","title":"SharedInstallmentAndLoc","data":{"properties":{"assetType":{"$ref":"#/components/schemas/LoanAssetType","readOnly":true},"chargedOffReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for loan charge off. Can be updated via the Update Loan endpoint when the loan status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off per loan type configuration after X days overdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudulent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off for fraudulent reason. If the loan is reported to one or more credit bureaus, the system will automatically send a special request to each bureau to delete the tradeline due to confirmed fraud. This is the only reason that the system will automatically trigger a request to delete the tradeline. For other reasons, if you need to delete the tradeline please call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delete from credit reporting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or use an agent tool."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of bankruptcy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of some legal reason."},"children":[]}]}]}],"enum":["term","fraudulent","bankruptcy","legal"],"nullable":true,"type":"string"},"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"mainBorrowerId":{"description":"The identifier of the main borrower of the loan","nullable":true,"type":"string"},"migration":{"allOf":[{"$ref":"#/components/schemas/Migration"},{"required":["migrationStatus","activatedDate","activatedTimeOfDay"],"type":"object"}]}},"type":"object"}},"components/schemas/PersonId":{"id":"components/schemas/PersonId","kind":"json-schema","title":"PersonId","data":{"description":"A borrower's unique identifier (who owns the loan). Can be Peach\nor a lender's external identifier.\n","type":"string","writeOnly":true}},"components/schemas/PersonLoan":{"id":"components/schemas/PersonLoan","kind":"json-schema","title":"PersonLoan","data":{"description":"Represents a borrower attached to a loan. A borrower can be an applicant,\nmain borrower, co-borrower, etc.\n","properties":{"loanRelationType":{"$ref":"#/components/schemas/PersonType"},"object":{"default":"personLoan","enum":["personLoan"],"readOnly":true,"type":"string"},"personId":{"$ref":"#/components/schemas/PersonId"}},"type":"object"}},"components/schemas/AmountsValidation":{"id":"components/schemas/AmountsValidation","kind":"json-schema","title":"AmountsValidation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object contains information on whether the total of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match to various amounts of the loan."},"children":[]}]}]}],"properties":{"amountFinancedMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced + originationFeeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We allow up to 1 cent difference in the match because of potential rounding issues. Only applicable if both"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are passed during origination; null otherwise."},"children":[]}]}]}]},"feesMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees portion is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFeeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalOtherFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only applicable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was passed during origination; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"interestMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interest portion is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalInterestAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We allow up 1 cent different in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the match because of potential rounding issues. Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was passed during origination; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"principalMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" principal portion is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We allow up 1 cent different in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the match because of potential rounding issues. Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was passed during origination; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"recurringAmountsMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka recurring amount) equals the first expected payment's recurring amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or expected payments schedule is not passed at origination."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"totalAdvancesMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"advanceSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" amounts is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"advanceSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was passed during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origination; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}],"nullable":true,"type":"boolean"}},"readOnly":true,"type":"object"}},"components/schemas/ChargeDate":{"id":"components/schemas/ChargeDate","kind":"json-schema","title":"ChargeDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for new loans"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that are created and activated from day zero ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonMigrated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans) on the Peach system will be ignored."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date on which the fee was charged in the product timezone. In other words, this is when the fee was booked and written to the ledger."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge date of the fee is different from the due date of the fee. The due date of the fee is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments.date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between the first and last dates (inclusive) of the period represented by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments.date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka the due date)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, you can also provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, the system will charge the fee on the first day of the period."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/ExpectedPaymentsAtActivation":{"id":"components/schemas/ExpectedPaymentsAtActivation","kind":"json-schema","title":"ExpectedPaymentsAtActivation","data":{"description":"Expected payments schedule for the loan at activation.\n","items":{"description":"The payment schedule at activation","properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the payment. The total amount is equal to: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAmount"},"children":[]}]}]}],"format":"float","type":"number"},"date":{"description":"Due date.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this will contain details of the dynamic fee."},"children":[]}]}]}],"properties":{"chargeDate":{"$ref":"#/components/schemas/ChargeDate"},"chargeTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value can be provided only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is passed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Peach system will determine and set the time of day."},"children":[]}]}]}],"type":"object"}]},"dynamicFeeTypeId":{"description":"The dynamic fee type identifier in the system.","nullable":true,"type":"string"}},"type":"object"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to interest (before any promo date(s) or discount). Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPayment"},"children":[]}]}]}],"format":"float","type":"number"},"interestBeforeDiscountAmount":{"description":"The amount of interest discount.","format":"float","type":"number"},"isForcedAmount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will honor the amount and will not update it on loan recalculations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the amount is less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system can increase the amount when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan is being recalculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most of the cases, the lender should set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka the default value.) If you need more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"explanation or advice on your use case, please contact the Peach team."},"children":[]}]}]}],"type":"boolean"},"paymentType":{"description":"The payment type.","enum":["periodicPayment","originationFee","drawFee","dynamicFee","downPayment","discountCredit"],"type":"string"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPayment"},"children":[]}]}]}],"format":"float","type":"number"},"unroundedInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedInterestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount. Available only for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"}},"required":["date","paymentType","amount"],"type":"object"},"nullable":true,"type":"array"}},"components/schemas/ExpectedPaymentsAtOrigination":{"id":"components/schemas/ExpectedPaymentsAtOrigination","kind":"json-schema","title":"ExpectedPaymentsAtOrigination","data":{"description":"Expected payments schedule for the loan at origination. The dates and amounts\nare exactly what a borrower agreed to and signed.\n","items":{"description":"The payment schedule at origination or draw","properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the payment. The total amount is equal to: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAmount"},"children":[]}]}]}],"format":"float","type":"number"},"date":{"description":"Due date.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this will contain details of the dynamic fee."},"children":[]}]}]}],"properties":{"chargeDate":{"$ref":"#/components/schemas/ChargeDate"},"chargeTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value can be provided only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is passed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Peach system will determine and set the time of day."},"children":[]}]}]}],"type":"object"}]},"dynamicFeeTypeId":{"description":"The dynamic fee type identifier in the system.","nullable":true,"type":"string"}},"type":"object"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to interest (before any promo date(s) or discount). Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPayment"},"children":[]}]}]}],"format":"float","type":"number"},"interestBeforeDiscountAmount":{"description":"The amount of interest discount.","format":"float","type":"number"},"isForcedAmount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will honor the amount and will not update it on loan recalculations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the amount is less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system can increase the amount when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan is being recalculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most of the cases, the lender should set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka the default value.) If you need more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"explanation or advice on your use case, please contact the Peach team."},"children":[]}]}]}],"type":"boolean"},"paymentType":{"description":"The payment type.","enum":["periodicPayment","originationFee","drawFee","dynamicFee","downPayment","discountCredit"],"type":"string"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPayment"},"children":[]}]}]}],"format":"float","type":"number"},"unroundedInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedInterestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount. Available only for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"}},"required":["date","paymentType","amount"],"type":"object"},"nullable":true,"type":"array"}},"components/schemas/LoanInvestor":{"id":"components/schemas/LoanInvestor","kind":"json-schema","title":"Loan Investor Association","data":{"properties":{"investorId":{"description":"The Investor's unique identifier, internal or lender's external.","type":"string"},"metro2":{"properties":{"reportK2Segment":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to loans that are reported to credit bureaus."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will report the K2 segment in the Metro2 file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate that the loan has been sold to a new investor. Peach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will continue to report the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will not report the K2 segment in the Metro2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file. Peach will continue to report the loan."},"children":[]}]}]}],"nullable":false,"type":"boolean"}},"type":"object"},"share":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ownership percentage of the loan. The format is decimal. For example, 0.01 is 1% ownership and 0.15 is 15% ownership."},"children":[]}]}]}],"format":"float","type":"number"}},"required":["investorId","share"],"title":"Loan Investor Association","type":"object"}},"components/schemas/LoanInvestorGet":{"id":"components/schemas/LoanInvestorGet","kind":"json-schema","title":"LoanInvestorGet","data":{"allOf":[{"$ref":"#/components/schemas/LoanInvestor"},{"properties":{"effectiveDate":{"description":"The date at which this ownership structure came into effect.","format":"date","type":"string"}},"type":"object"}]}},"components/schemas/LoanInvestorsGet":{"id":"components/schemas/LoanInvestorsGet","kind":"json-schema","title":"LoanInvestorsGet","data":{"items":{"$ref":"#/components/schemas/LoanInvestorGet"},"type":"array"}},"components/schemas/MerchantDiscountRateObj":{"id":"components/schemas/MerchantDiscountRateObj","kind":"json-schema","title":"MerchantDiscountRateObj","data":{"description":"This object represents optional configurations for the MDR (Merchant Discount Rate). When POS (point of sale)\nlenders issue loans, the merchant pays some percentage of the financed amount - called the MDR.\n","nullable":true,"properties":{"amortizationPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of calendar days. If a value is passed, the system will amortize the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" over the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amortizationPeriod"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of calendar days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is not passed or the value exceeds the loan life, the system will amortize the MDR amount over the life of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan. For Line of Credit, it is required to provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amortizationPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For Installment loans, it is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recommended to leave the value empty."},"children":[]}]}]}],"nullable":true,"type":"number"},"isAmortized":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to amortize the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the straight-line amortization method over the life of the loan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to recognize the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as revenue in full on the day when the loan is activated."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"mdrAmount":{"description":"The Merchant Discount Amount.","format":"float","nullable":true,"type":"number"}},"type":"object"}},"components/schemas/MerchantDiscountRateObjWithRate":{"id":"components/schemas/MerchantDiscountRateObjWithRate","kind":"json-schema","title":"MerchantDiscountRateObjWithRate","data":{"allOf":[{"properties":{"mdrRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Discount Rate (MDR). The format is decimal. For example, 0.03 is a 3% annual rate, 0.2 is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20% annual rate. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, the system will calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by multiplying"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mdrRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"type":"object"},{"$ref":"#/components/schemas/MerchantDiscountRateObj"}]}},"components/schemas/LoanOriginationLicense":{"id":"components/schemas/LoanOriginationLicense","kind":"json-schema","title":"LoanOriginationLicense","data":{"description":"The license that was used to originate the loan.","enum":["nationalBank","stateLicense","bankSubsidiary","stateBank"],"type":"string"}},"components/schemas/RateCapMaxRate":{"id":"components/schemas/RateCapMaxRate","kind":"json-schema","title":"RateCapMaxRate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum spread interest rate that can accrue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the calculated rate on a given day is greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cap the rate and accrue a maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the loan. Else, we will use the calculated rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format is decimal. For example, 0.36 is 36% annual rate cap."},"children":[]}]}]}],"format":"float","minimum":0,"type":"number"}},"components/schemas/RateCapReason":{"id":"components/schemas/RateCapReason","kind":"json-schema","title":"RateCapReason","data":{"default":"other","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is not used for any compliance logic, only for informational purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MLA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Military Lending Act (36% cap for active duty military)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCRA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Servicemembers Civil Relief Act"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"federal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other federal regulations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - State-specific regulations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other regulatory or business reasons"},"children":[]}]}]}]}],"enum":["MLA","SCRA","federal","state","other"],"type":"string"}},"components/schemas/RateCapAtOrigination":{"id":"components/schemas/RateCapAtOrigination","kind":"json-schema","title":"Rate Cap At Origination","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rate cap definition for loan origination. Uses days-based duration instead of specific dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate caps prevent calculated rates (spread + index) from exceeding regulatory limits."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When multiple rate caps overlap, the system uses the lowest value."},"children":[]}]}]}],"properties":{"days":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of calendar days the rate cap applies from loan origination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null, the rate cap applies for the entire loan term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[{\"days\": 30, \"maxRate\": 0.1},\n{\"days\": 60, \"maxRate\": 0.2},\n{\"days\": null, \"maxRate\": 0.25}]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[{\"days\": 30, \"maxRate\": 0.1},\n{\"days\": 60, \"maxRate\": 0.2},\n{\"days\": null, \"maxRate\": 0.25}]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan will accrue interest with a rate cap of 10% for the first 30 days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Between days 31-90 the loan will accrue interest with a rate cap of 20%."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From day 91 until the end, the loan will accrue interest with a rate cap of 25%."},"children":[]}]}]}],"nullable":true,"type":"number"},"maxRate":{"$ref":"#/components/schemas/RateCapMaxRate"},"rateCapReason":{"$ref":"#/components/schemas/RateCapReason"}},"required":["maxRate","days","rateCapReason"],"title":"Rate Cap At Origination","type":"object"}},"components/schemas/RateCapsAtOriginationLoan":{"id":"components/schemas/RateCapsAtOriginationLoan","kind":"json-schema","title":"Rate Caps At Origination","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate caps that should apply to the loan at origination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the loan is created these rate caps are created and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied to the loan. They will be accessible via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".../rate-caps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RateCapAtOrigination"},"nullable":true,"title":"Rate Caps At Origination","type":"array"}},"components/schemas/InstallmentAtOrigination":{"id":"components/schemas/InstallmentAtOrigination","kind":"json-schema","title":"Installment","data":{"description":"This object contains loan details and terms as they were shown to a borrower at origination.","properties":{"advanceSchedule":{"$ref":"#/components/schemas/AdvanceSchedule"},"amortizationMethod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equalPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal (except maybe for the last payment)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most installment loans are expected to use this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal to interest only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the last payment will include the entire principal. Keep in mind that if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest.periodAccrualDurationType=actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the recurring payment amounts will be different every period for monthly and twice monthly frequencies. This is because a month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can have 28, 29, 30 or 31 days and interest accrued will vary based on the number of days in the month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are additional limitations to be aware for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For installment loans, Autopay can only be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aligned to due dates. It means that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay.allowedFrequency.isDueDatesAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This way the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will only allow Autopay to be aligned to the loan frequency and due dates."},"children":[]}]}]}],"enum":["equalPayments","interestPaymentsBalloonPrincipal","custom"],"readOnly":true,"type":"string"},"amountFinanced":{"description":"The amount financed. The amount of money a borrower received from the lender, minus the upfront fees (e.g. origination fee) the lender is charging the borrower.\n","format":"float","type":"number"},"aprEffective":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"aprNominal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nominal APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"bufferToPushOutSchedule":{"$ref":"#/components/schemas/BufferToPushOutSchedule"},"discountProgramIds":{"description":"The identifiers of the discount programs provided at origination. A discount program\nhas to be created before it can be applied to loans.\n","items":{"type":"integer"},"nullable":true,"type":"array"},"downPaymentAmount":{"description":"The amount of down payment made when the loan was originated. The value should be equal to what a\nborrower agreed to and signed at origination.\n","format":"float","type":"number"},"duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the loan as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency=monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is a loan with 6 months duration and will have 6 due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency=weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is a loan with 24 weeks duration and will have 24 due dates."},"children":[]}]}]}]}],"type":"number"},"enforcedEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The enforced end date of the loan in the product timezone. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enforcedEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, it will be set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enforcedEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, the last"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment due date MUST match "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enforcedEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"expectedPayments":{"$ref":"#/components/schemas/ExpectedPaymentsAtOrigination"},"fees":{"description":"The loan fees.","properties":{"dynamicFees":{"$ref":"#/components/schemas/AtOriginationDynamicFees"},"originationFeeAmount":{"description":"The amount of the origination fee.","format":"float","nullable":true,"type":"number"},"serviceFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service fee amount that will be charged recurrently. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic."},"children":[]}]}]}],"format":"float","type":"number"},"totalOtherFeesAmount":{"description":"The total amount of non-origination fees that are expected to be charged on the loan. The value should be\nequal to what a borrower agreed to and signed at origination.\n","format":"float","nullable":true,"type":"number"}},"type":"object"},"interestRates":{"$ref":"#/components/schemas/LoanInterestRatesAtOrigination"},"investors":{"allOf":[{"$ref":"#/components/schemas/LoanInvestorsGet"}],"description":"A list of the investors who owned the loan at origination.\nIf none are provided, it defaults to the default investor configured for the lender.\n"},"isValidMerchantId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID exists in Peach Merchants table."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID doesn't exist in Peach Merchants table."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit card lenders normally should not create merchants details in Peach and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute can be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point of sale lenders normally have merchants details in Peach and can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute as needed."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"itemsOrServicesFinanced":{"description":"Merchandise, services or other value provided in exchange for the debt. For example: refrigerator\nor kitchen renovation. This description is used in communications with the borrower, when needed.\n","nullable":true,"type":"string"},"mdr":{"$ref":"#/components/schemas/MerchantDiscountRateObjWithRate"},"merchantId":{"description":"A lender's identifier for the merchant.\n","nullable":true,"type":"string"},"originatingCreditorName":{"description":"The name of an entity that originated the loan. For example: Bank of Mars. This name will be\nused in communications with the borrower when needed.\n","type":"string"},"originationLicense":{"$ref":"#/components/schemas/LoanOriginationLicense"},"paymentFrequency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment frequency of the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - are recurring."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a single term loan (aka non-recurring). It will create one period only with a desired \"duration\" of 30,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60, 90, 120, X calendar days or a specific date that should be passed in specificDays. For example [90]."},"children":[]}]}]}],"enum":["weekly","everyTwoWeeks","twiceMonthly","monthly","singleTerm"],"type":"string"},"periodicPaymentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amortized periodic payment amount excluding fees. Keep in mind that the last payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required when passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at origination."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"personAddress":{"$ref":"#/components/schemas/Address"},"personAddressId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the existing identifier of a borrower's address contact information (Peach's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unique or lender's external identifier). If passed during origination, the address will be stored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the loan object as a reference. Alternatively, the address can be directly provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddressId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not be sent."},"children":[]}]}]}],"pattern":"^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string","writeOnly":true},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of principal at origination. Lenders should only pass this value if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is provided, the system will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the loan principal for interest calculations and amortization. The value should be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is not provided, the system will:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAmount = amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the loan principal for interest calculations and amortization."},"children":[]}]}]}]}],"format":"float","nullable":true,"type":"number"},"promoRates":{"$ref":"#/components/schemas/LoanPromoRatesAtOrigination","nullable":true},"rateCaps":{"$ref":"#/components/schemas/RateCapsAtOriginationLoan"},"skipCreditReporting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the loan should not be reported to the credit agencies when activated."},"children":[]}]}]}],"type":"boolean"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"},"totalDiscountAmount":{"description":"The total amount of discount at origination as a result of promo rates. The value should be equal to what\na borrower agreed to and signed at origination.\n","format":"float","type":"number"},"totalInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of interest the loan should accrue. The value should be equal to what a borrower agreed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to and signed at origination. Because of rounding issues, the total of expected payments "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAmount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"might be different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalInterestAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"totalInterestCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of interest the borrower will ever pay."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not applicable, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"validAddress":{"default":false,"description":"Identifies the address at origination as valid or invalid.","readOnly":true,"type":"boolean"}},"title":"Installment","type":"object"}},"components/schemas/PromoEndDate":{"id":"components/schemas/PromoEndDate","kind":"json-schema","title":"PromoEndDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program end-date without a potential grace"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will calculate the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date field should be in the product timezone."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/PromoGracePeriodDays":{"id":"components/schemas/PromoGracePeriodDays","kind":"json-schema","title":"PromoGracePeriodDays","data":{"description":"The promotional program grace period as a number of calendar days.\nGrace period allows the borrower to exercise the promotional program\nfor an additional number of days after it expires.\n\nIf you don't pass a value, the system will assume zero (aka no grace\nperiod).\n","type":"integer"}},"components/schemas/PromoStartDate":{"id":"components/schemas/PromoStartDate","kind":"json-schema","title":"PromoStartDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date marks the start date from which a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program is valid and will be evaluated to be exercised."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a promo program is created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For installment loans:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be a date in the future but not after the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan's last due date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotion is valid and evaluated after it has been activated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrived."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be a date in the past but not before the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan's activation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not passed, the system will set the promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the loan activation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Same as Cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" promo programs, the waiving of interest benefit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be added from the loan activation date for the entire life of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan for installment loans, regardless of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Line of Credit draws:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be a date in the future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotion is valid and evaluated after it has been activated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrived."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be a date in the past."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is not passed, the system will set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStartDate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be the date of the activation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date value should be in the product timezone."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/PromoProgramFields":{"id":"components/schemas/PromoProgramFields","kind":"json-schema","title":"PromoProgramFields","data":{"properties":{"disqualifyOverdueDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of loan overdue days that would disqualify the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any occurrence of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualifyOverdueDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or more of number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days overdue during the promotional period would disqualify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(aka cancel) the promotional program."},"children":[]}]}]}],"type":"integer"},"externalId":{"description":"A lender's unique identifier for a specific promotional\nprogram.\n","type":"string"},"metaData":{"description":"Store any type of key/value pairs in the form of a JSON\ndictionary.\n","nullable":true,"type":"object"},"promoDurationDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program duration as a number of calendar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will calculate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"promoEndDate":{"$ref":"#/components/schemas/PromoEndDate"},"promoGracePeriodDays":{"$ref":"#/components/schemas/PromoGracePeriodDays"},"promoStartDate":{"$ref":"#/components/schemas/PromoStartDate"},"promoTypeId":{"description":"The promotional program type's unique identifier.","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was created but was not activated yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For promo program creation, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"installment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created in either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For line of credit / draws, a promo program can only be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and transitioned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status via the promo program activate endpoint."},"children":[]}]}]}],"enum":["pending","active"],"type":"string"}},"type":"object"}},"components/schemas/PromoProgramCreate":{"id":"components/schemas/PromoProgramCreate","kind":"json-schema","title":"PromoProgramCreate","data":{"allOf":[{"required":["promoTypeId","status"]},{"$ref":"#/components/schemas/PromoProgramFields"},{"properties":{"id":{"description":"The promotional program's unique identifier.","readOnly":true,"type":"string"}},"type":"object"}],"description":"Create a promo program"}},"components/schemas/PromoProgramAtOrigination":{"id":"components/schemas/PromoProgramAtOrigination","kind":"json-schema","title":"PromoProgramAtOrigination","data":{"properties":{"promoPrograms":{"description":"The list of promotional programs that the loan is eligible for.","items":{"$ref":"#/components/schemas/PromoProgramCreate"},"nullable":true,"type":"array"}},"type":"object"}},"components/schemas/InterestRateValidation":{"id":"components/schemas/InterestRateValidation","kind":"json-schema","title":"InterestRateValidation","data":{"properties":{"interestRateAtOrigBelowMin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interest rate at origination is below the minimum interest rate."},"children":[]}]}]}],"type":"boolean"},"interestRateAtOrigExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interest rate at origination exceeds the maximum interest rate."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/AprValidation":{"id":"components/schemas/AprValidation","kind":"json-schema","title":"AprValidation","data":{"properties":{"aprEffectiveAtActExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the effective APR at activation exceeds the maximum APR."},"children":[]}]}]}],"type":"boolean"},"aprEffectiveAtOrigExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the effective APR at origination exceeds the maximum APR."},"children":[]}]}]}],"type":"boolean"},"aprNominalAtActExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the nominal APR at activation exceeds the maximum APR."},"children":[]}]}]}],"type":"boolean"},"aprNominalAtOrigExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the nominal APR at origination exceeds the maximum APR."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/RatesValidation":{"id":"components/schemas/RatesValidation","kind":"json-schema","title":"RatesValidation","data":{"allOf":[{"$ref":"#/components/schemas/InterestRateValidation"},{"$ref":"#/components/schemas/AprValidation"}],"description":"This object contains information on whether actual rates exceed the rate ranges defined on the loan type.","readOnly":true}},"components/schemas/LoanServicer":{"id":"components/schemas/LoanServicer","kind":"json-schema","title":"LoanServicer","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity type that services the loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyServicer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the loan is serviced on the Peach platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtCollectionAgency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the loan is no longer serviced on the Peach platform. The loan can be still visible in Borrower Portal. To clarify, the loan is not deleted from the Peach platform."},"children":[]}]}]}],"enum":["creditor","thirdPartyServicer","debtCollectionAgency"],"type":"string"}},"components/schemas/LoanStatus":{"id":"components/schemas/LoanStatus","kind":"json-schema","title":"LoanStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the loan. New loans must be created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan is in the application stage. Loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details and terms can be changed (via API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was signed by the borrower and originated by the lender. Loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details cannot be changed. Originated loans do not start accruing interest until activated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an application was declined. This is a terminal state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan is active. Most loans are expected to be active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan is temporarily frozen. The loan will not accrue any interest, no payments can be processed, and no notifications are sent to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was accelerated. The loan will not accrue any additional interest and the entire balance is due."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was charged off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was successfully paid off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was canceled. Canceled loans are not shown in UI. This is a terminal state."},"children":[]}]}]}],"enum":["pending","originated","declined","active","frozen","accelerated","chargedOff","paidOff","canceled"],"type":"string"}},"components/schemas/Installment":{"id":"components/schemas/Installment","kind":"json-schema","title":"Installment","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixinWithoutTimestamps"},{"properties":{"loanTypeId":{"description":"The loan type identifier. This is created specifically for each lender's loan product by Peach.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseLoanMixin"},{"$ref":"#/components/schemas/SharedInstallmentAndLoc"},{"properties":{"additionalPeople":{"description":"For loans with multiple people attached, use this field to add additional people.\nYou do not need to include the main borrower, who will be created from the url parameter.\n","items":{"$ref":"#/components/schemas/PersonLoan"},"type":"array","writeOnly":true},"amountsValidation":{"$ref":"#/components/schemas/AmountsValidation"},"aprEffectiveAtActivation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APR that was calculated by Peach at loan activation. The format is decimal. For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example, 0.01 is 1%, 0.2 is 20%. If the origination and activation dates are the same,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffectiveAtActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the origination and activation dates are different, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might be different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffectiveAtActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it could not be computed."},"children":[]}]}]}],"format":"float","nullable":true,"readOnly":true,"type":"number"},"aprNominalAtActivation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APR that was calculated by Peach at loan activation. The format is decimal. For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example, 0.01 is 1%, 0.2 is 20%. If the origination and activation dates are the same,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominalAtActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the origination and activation dates are different, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might be different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominalAtActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it could not be computed."},"children":[]}]}]}],"format":"float","nullable":true,"readOnly":true,"type":"number"},"atActivation":{"description":"This object contains loan details and terms at the time of loan activation.","properties":{"expectedPayments":{"$ref":"#/components/schemas/ExpectedPaymentsAtActivation"}},"readOnly":true,"title":"Installment","type":"object"},"atOrigination":{"allOf":[{"$ref":"#/components/schemas/InstallmentAtOrigination"},{"$ref":"#/components/schemas/PromoProgramAtOrigination"}]},"current":{"allOf":[{"properties":{"autopayEnabled":{"description":"Whether Autopay is enabled for this loan.\n","type":"boolean"},"duration":{"$ref":"#/components/schemas/LoanDuration"},"paymentFrequency":{"$ref":"#/components/schemas/InstallmentPaymentFrequency"},"periodicPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most recent amortized periodic payment that was calculated on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastAmortizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"type":"object"}],"description":"This object contains some loan details that were modified after origination.","readOnly":true},"isClosed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the loan with multiple advances is closed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the loan type installment with multiple advances, new Advances"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be created, and the advance schedule cannot be updated."},"children":[]}]}]}],"type":"boolean"},"muteLoanNotices":{"description":"Indicates whether the system should stop/pause sending loan related notices to the borrower. Set to true if you want to mute all loan related notices (e.g. loanDetails. autopayEnabled, paymentFailed, etc.) Keep in mind that it will also stop all notices related to the loan that are sent from Peach Agent Portal by an agent.\nNote: this is not the only attribute that can stop notices from being sent. Compliance Guard and Cases Do Not Interact can also block communications.\n","type":"boolean"},"nickname":{"description":"The loan's nickname. Nickname is a friendly name of the loan and is displayed in the UI.\nNickname is different from loan ID. Nickname can be changed by a borrower.\n","nullable":true,"type":"string"},"object":{"enum":["installment"],"readOnly":true,"type":"string"},"ratesValidation":{"$ref":"#/components/schemas/RatesValidation"},"servicedBy":{"$ref":"#/components/schemas/LoanServicer"},"status":{"$ref":"#/components/schemas/LoanStatus"},"type":{"enum":["installment"],"type":"string"}},"type":"object"}],"title":"Installment"}},"components/schemas/LOCMinPaymentCalculation":{"id":"components/schemas/LOCMinPaymentCalculation","kind":"json-schema","title":"LOCMinPaymentCalculation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logic to calculate the minimum payment amount when a statement is created. All interest accrued in the period and fees are always part"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the minimum payment amount plus a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOverLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true at the draw level, the minimum payment amount will include the over limit amount at the time of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statement generation as part of the required minimum payment for each draw. The overlimit amount will be distributed/allocated according to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentWaterfall.multi.loansOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration at the loanType level (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"highestInterestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement logic adds up all draws calculated minimum payment amounts (including overlimit amounts, if applicable) and adds all unpaid fees"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to set the total statement minimum amount. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.statement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is configured such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOverdueAmountInMinPayment=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the statement minimum payment amount will include the overdue amount as part of the required minimum payment displayed on the statement."},"children":[]}]}]}],"properties":{"minAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum periodic amount. For example: $35.00. The minimum will be only enforced if draws on the line of credit do not have an amortized amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assume "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the loan-level is set to $35.00."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 1 outstanding principal is $100.00."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 1 percentageOfPrincipal=0.01 (aka 1%)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 1 interest rate is 2% per month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 1 interest amount per month is: $100.00 * 2% = $2.00."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 1 minimum amount is: $2 + $100.00 * 1% = $3.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 2 outstanding principal is $200.00."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 2 percentageOfPrincipal=0.02 (aka 2%)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 2 interest rate is 3% per month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 2 interest amount per month is: $200.00 * 3% = $6.00."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw 2 minimum amount is: $6 + $200.00 * 1% = $8.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan level fees: Fee 1 is $5.00, Fee 2 is $7.50. Both are unpaid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan-level minimum payment calculation is max($35.00, [$3.00 (draw 1 minimum) + $8.00 (draw 2 minimum) + $5.00 (fee 1) + $7.50 (fee 2)]) = max($35, $23.50) = $35"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum payment will be set to $35.00 and not $23.50. The split between principal, interest, and fees will be fees=$12.50, interest=$8.00 and principal=$14.50."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Principal will be allocated first according to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on each draw (e.g., $1 for draw 1 and $2 for draw 2 in the example above). The remaining"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"principal amount ($11.50 in the example) will be allocated to draws based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loansOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multi"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" waterfall configuration at the loanType level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the example above, assuming draw 1 is ordered before draw 2, the $11.50 will be allocated to draw 1. Draw 1 minimum amount will increase to ($3.00 + $11.50) = $14.50."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/LineOfCreditAtOrigination":{"id":"components/schemas/LineOfCreditAtOrigination","kind":"json-schema","title":"Line of Credit","data":{"description":"This object contains loan details and terms as they were shown to a borrower at origination.","properties":{"aprEffective":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and show them as the APR (for example, on the statement.)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"aprNominal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nominal APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and show them as the APR (for example, on the statement.)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"aprVariableRange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APR range if the loan has variable APR/interest rate. If the loan has a fixed APR/interest rate, keep this attribute empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used to be displayed on emails, Borrower Portal, statements and other UI elements. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprVariableRange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"passed, the statement will show "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(v) = Variable Rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" next to the APR values. The range should not change after the loan was originated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest rate (also called the current effective APR) can change using Loans Management Rates endpoints. Keep in mind that this range"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is applicable to all Draws. Draw object doesn't have its own aprVariableRange attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is decimal up to 4 decimal places. First value is minimum rate (inclusive). Second value is maximum rate (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[0.1999, 0.2999] - is 19.99% - 29.99% APR."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[0.01, 0.03] - is 1.00% - 3.00% APR."},"children":[]}]}]}]}],"example":[0.1999,0.2999],"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"nullable":true,"type":"array"},"bufferToPushOutSchedule":{"$ref":"#/components/schemas/BufferToPushOutSchedule"},"creditLimitAmount":{"description":"The credit limit amount.","format":"float","type":"number"},"discountProgramIds":{"items":{"description":"The identifiers of the discount programs provided at origination. A discount program\nhas to be created before it can be applied to loans.\n","type":"integer"},"nullable":true,"type":"array"},"downPaymentAmount":{"description":"The amount of down payment made when the loan was originated.","format":"float","type":"number"},"fees":{"description":"The loan fees.","properties":{"dynamicFees":{"$ref":"#/components/schemas/AtOriginationDynamicFees"},"originationFeeAmount":{"description":"The amount of the origination fee.","format":"float","nullable":true,"type":"number"},"serviceFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service fee amount that will be charged recurrently. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"gracePeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logic to handle the grace period benefit. The grace period benefit allows the borrower not to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accrue interest on the line and its draws as long as they pay the required balance every period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan/line and all draws must meet the grace period repayment requirement. If one of the draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"didn't meet the repayment requirement (in other words the entire line didn't meet the repayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requirement), all applicable/enrolled draws would lose the grace period benefit and accrue interest."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To configure the grace period benefit:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other attributes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when you create the line/loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to pass a draw-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. Please read more details about the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object in the Create draw endpoint. If the loan/line "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all draws of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the line participate in the evaluation of the loan/line grace period benefit eligibility. But not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all draws have to receive the grace period benefit - you can decide what draws should accrue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest even if the line is eligible for the benefit. For example, amortized draws can participate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the grace period benefit eligibility, but are not designed to be eligible for grace period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"benefit (in other words, amortized draws are expected to accrue interest if an interest rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than zero was set on the draw)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important: the grace period attributes cannot be changed after the line is activated."},"children":[]}]}]}],"properties":{"isGracePeriodApplicable":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the line is enrolled in the grace period benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the grace period benefit is eligible on the loan/line level."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan/line and all draws must meet the grace period repayment requirement. If one of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draws didn't meet the repayment requirement (in other words the entire line didn't meet the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repayment requirement), all draws eligible for the grace period benefit would lose the grace"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period benefit and accrue interest."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to pass details of how draws are evaluated in the grace period benefit - read more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details about the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object in the Create draw endpoint."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the grace period benefit is not eligible on the loan/line level."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot enroll individual draws in the grace period benefit."},"children":[]}]}]}]}]}]}],"type":"boolean"},"numPeriodsToRestoreGrace":{"default":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods to wait after the grace period benefit was revoked before the line/loan can become eligible again."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To take advantage of the grace period, the borrower must pay their account balance according to the grace period benefit requirements on time for the number of billing periods provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this attribute is passed, it will be used to set the draw-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numPeriodsToRestoreGrace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for any draw that is enrolled in the grace period benefit (aka "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will ensure that the line and all draws have the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numPeriodsToRestoreGrace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is required to be passed if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be greater than zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is not required and won't be used if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is not passed or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":1,"type":"integer"}},"type":"object"},"interestRates":{"$ref":"#/components/schemas/LoanInterestRatesAtOrigination"},"investors":{"allOf":[{"$ref":"#/components/schemas/LoanInvestorsGet"}],"description":"A list of the investors who owned the loan at origination.\nIf none are provided, it defaults to the default investor configured for the lender.\n"},"isValidMerchantId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID exists in Peach Merchants table."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - if the merchant ID doesn't exist in Peach Merchants table."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit card lenders normally should not create merchants details in Peach and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute can be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point of sale lenders normally have merchants details in Peach and can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMerchantIdValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute as needed."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"itemsOrServicesFinanced":{"description":"Merchandise, services or other value provided in exchange for the debt. For example: refrigerator\nor kitchen renovation. This description is used in communications with the borrower, when needed.\n","nullable":true,"type":"string"},"merchantId":{"description":"A lender's identifier for the merchant.\n","nullable":true,"type":"string"},"minPaymentCalculation":{"$ref":"#/components/schemas/LOCMinPaymentCalculation"},"originatingCreditorName":{"description":"The name of an entity that originated the loan. For example: Bank of Mars. This name will be\nused in communications with the borrower when needed.\n","type":"string"},"originationLicense":{"$ref":"#/components/schemas/LoanOriginationLicense"},"paymentFrequency":{"enum":["weekly","everyTwoWeeks","twiceMonthly","monthly"],"type":"string"},"personAddress":{"$ref":"#/components/schemas/Address"},"personAddressId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the existing identifier of a borrower's address contact information (Peach's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unique or lender's external identifier). If passed during origination, the address will be stored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the loan object as a reference. Alternatively, the address can be directly provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personAddressId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not be sent."},"children":[]}]}]}],"pattern":"^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string","writeOnly":true},"promoRates":{"$ref":"#/components/schemas/LoanPromoRatesAtOrigination","nullable":true},"rateCaps":{"$ref":"#/components/schemas/RateCapsAtOriginationLoan"},"skipCreditReporting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the loan should not be reported to the credit agencies when activated."},"children":[]}]}]}],"type":"boolean"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"},"validAddress":{"default":false,"description":"Identifies the address at origination as valid or invalid.","readOnly":true,"type":"boolean"}},"title":"Line of Credit","type":"object"}},"components/schemas/PaymentHoldDays":{"id":"components/schemas/PaymentHoldDays","kind":"json-schema","title":"PaymentHoldDays","data":{"description":"Determines how long the lender wants to wait until a payment affects the openToBuy amount in the\nGet balances endpoint.\n","nullable":true,"properties":{"holdDayType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines what type of day should be used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the transaction."},"children":[]}]}]}],"enum":["calendar","business"],"type":"string"},"numHoldDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days Peach's system will wait until the loan's balance reflects the amount of payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDayType=calendar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a borrower makes a one time payment on October 10th (and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the payment status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numHoldDays = 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment will increase the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the 10th."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numHoldDays = 1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment will increase the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the 11th."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numHoldDays = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment will increase the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the 12th."},"children":[]}]}]}],"type":"integer"}},"required":["holdDayType","numHoldDays"],"type":"object"}},"components/schemas/LineOfCredit":{"id":"components/schemas/LineOfCredit","kind":"json-schema","title":"Line of Credit","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixinWithoutTimestamps"},{"properties":{"loanTypeId":{"description":"The loan type identifier. This is created specifically for each lender's loan product by Peach.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseLoanMixin"},{"$ref":"#/components/schemas/SharedInstallmentAndLoc"},{"properties":{"additionalPeople":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalBorrowers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For loans with multiple people attached, use this field to add additional people."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You do not need to include the main borrower, who will be created from the url parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PersonLoan"},"type":"array","writeOnly":true},"atOrigination":{"$ref":"#/components/schemas/LineOfCreditAtOrigination"},"current":{"properties":{"autopayEnabled":{"description":"Is autopay enabled for this loan?","type":"boolean"},"creditLimitAmount":{"description":"The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n","format":"float","type":"number"}},"readOnly":true,"type":"object"},"isClosed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the LOC is closed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", new Draws or Purchases cannot be created. The system will continue to create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statements as long as there is unpaid balance."},"children":[]}]}]}],"type":"boolean"},"muteLoanNotices":{"description":"Indicates whether the system should stop/pause sending loan related notices to the borrower. Set to true if you want to mute all loan related notices (e.g. loanDetails. autopayEnabled, paymentFailed, etc.) Keep in mind that it will also stop all notices related to the loan that are sent from Peach Agent Portal by an agent.\nNote: this is not the only attribute that can stop notices from being sent. Compliance Guard and Cases Do Not Interact can also block communications.\n","type":"boolean"},"newDrawsAllowed":{"description":"Indicates if the borrower can make additional draws on the line.","type":"boolean"},"nickname":{"description":"The loan's nickname. Nickname is a friendly name of the loan and is displayed in the UI.\nNickname is different from loan ID. Nickname can be changed by a borrower.\n","nullable":true,"type":"string"},"object":{"enum":["lineOfCredit"],"readOnly":true,"type":"string"},"paymentHoldDays":{"$ref":"#/components/schemas/PaymentHoldDays"},"ratesValidation":{"allOf":[{"$ref":"#/components/schemas/InterestRateValidation"}],"description":"This object contains information on whether actual rates exceed the rate ranges defined on the loan type.","readOnly":true},"servicedBy":{"$ref":"#/components/schemas/LoanServicer"},"status":{"$ref":"#/components/schemas/LoanStatus"},"type":{"enum":["lineOfCredit"],"type":"string"}},"required":["newDrawsAllowed"],"type":"object"}],"title":"Line of Credit"}},"components/schemas/Loan":{"id":"components/schemas/Loan","kind":"json-schema","title":"Loan","data":{"anyOf":[{"$ref":"#/components/schemas/Installment"},{"$ref":"#/components/schemas/LineOfCredit"}],"description":"Represents a loan. A loan always belongs to a borrower, and most of\nthe interactions between a lender and a borrower are associated with a\nparticular loan.\n","title":"Loan"}},"components/schemas/IsLocked":{"id":"components/schemas/IsLocked","kind":"json-schema","title":"IsLocked","data":{"properties":{"isLocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the loan is in the middle of being updated or replayed. The returned data are not consistent. The caller should poll"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get loan lock status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isLocked`` becomes "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false`, the caller should call this endpoint again to get consistent data."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/AuthorizedAmount":{"id":"components/schemas/AuthorizedAmount","kind":"json-schema","title":"AuthorizedAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of purchases in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used in the calculation of the following amounts: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utilizationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is NOT used in the calculations of the following amounts: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to lines of credit."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/DueBalances":{"id":"components/schemas/DueBalances","kind":"json-schema","title":"DueBalances","data":{"description":"Due balances represent balances that are currently due.","properties":{"dueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueOriginationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDrawFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueLateFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueModificationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueMembershipFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"dueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueMembershipFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"duePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dueTotalAmount":{"description":"The total due balance sums due principal, interest, and fees.","format":"float","readOnly":true,"type":"number"}},"type":"object"}},"components/schemas/NonDueBalances":{"id":"components/schemas/NonDueBalances","kind":"json-schema","title":"NonDueBalances","data":{"description":"Non-due balances represent balances that are not yet due.","properties":{"nonDueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueOriginationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueDrawFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueLateFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueModificationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueMembershipFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"nonDueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueMembershipFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDuePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonDueTotalAmount":{"description":"The total non-due balance sums non-due principal, interest, and fees.","format":"float","readOnly":true,"type":"number"}},"type":"object"}},"components/schemas/OpenToBuyAmount":{"id":"components/schemas/OpenToBuyAmount","kind":"json-schema","title":"OpenToBuyAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of available credit a borrower has based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utilizationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and transactions' hold day end date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"take into account transactions' hold days. In other words, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more optimistic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes into account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases decrease the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to lines of credit."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/OverLimitAmount":{"id":"components/schemas/OverLimitAmount","kind":"json-schema","title":"OverLimitAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of credit used above the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the line of credit or draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max(0, utilizationAmount - authorizedAmount - creditLimitAmount)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",  meaning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the over limit amount will only be > 0 if utilization (without authorized purchases)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is greater than credit limit. Otherwise, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always be 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't take into account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases don't impact the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to line of credits."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/OverdueBalances":{"id":"components/schemas/OverdueBalances","kind":"json-schema","title":"OverdueBalances","data":{"description":"Overdue balances represent balances that are overdue.","properties":{"overdueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueOriginationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueDrawFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueLateFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueModificationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueMembershipFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"overdueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueMembershipFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overduePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"overdueTotalAmount":{"description":"The total overdue balance sums overdue principal, interest, and fees.","format":"float","readOnly":true,"type":"number"}},"type":"object"}},"components/schemas/UtilizationAmount":{"id":"components/schemas/UtilizationAmount","kind":"json-schema","title":"UtilizationAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan or draw utilization amount. In other words, the amount of credit used by the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount is calculated based on the loan type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimit.utilizationCalculation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: line of credit utilization can be calculated as the sum of principal buckets only without any interest or fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utilizationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes into account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases increase the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utilizationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount can be negative. Negative amount happens only when the total amount of payments made by the borrower plus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the total amount of service credits exceeds the line or draw balance. Any future purchases will first deplete the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overpayment amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to line of credits or installment loans with multi-advances."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/Balances":{"id":"components/schemas/Balances","kind":"json-schema","title":"Balances","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"description":"The up-to-date loan balances as of the time of inquiry.","properties":{"authorizedAmount":{"$ref":"#/components/schemas/AuthorizedAmount"},"availableCreditAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available credit amount to use. If the borrower exceeded their credit limit, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes into account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases decrease the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount can be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It happens only when the total amount of payments made by the borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plus the total amount of service credits exceeds the line or draw balance. Any future purchases will first deplete the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overpayment amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to lines of credit or installment loans with multi-advances."},"children":[]}]}]}],"format":"float","type":"number"},"calculatedAt":{"description":"Timestamp when the balances were calculated.","format":"date-time","type":"string"},"chargedOffBalances":{"description":"Charged-off balances represent balances that are charged-off.","properties":{"chargedOffFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"chargedOffInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"chargedOffPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"chargedOffTotalAmount":{"description":"The total charged-off balance sums charged-off principal, interest, and fees.","format":"float","type":"number"}},"type":"object"},"creditLimitAmount":{"description":"The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n","format":"float","type":"number"},"dueBalances":{"$ref":"#/components/schemas/DueBalances"},"interestAndFeesAmounts":{"description":"Interest and fees amounts","properties":{"deferredInterestAccruedTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total deferred interest accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the deferred interest promotion is exercised, the deferred"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest is foregone and therefore this attribute will have a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value of zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this scenario, the deferred interest amount will \"move\" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forgoneInterestDeferredAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the deferred interest promotion is not executed, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deferred interest is recognized as regular interest and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"therefore this attribute will have a value of zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this scenario, the deferred interest amount will \"move\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAccruedTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}]}],"format":"float","type":"number"},"deferredInterestDiscountTotalAmount":{"description":"The total deferred interest discount.\n","format":"float","type":"number"},"feesChargedYearToDateAmount":{"description":"The amount of fees charged year-to-date.\n","format":"float","type":"number"},"forgoneInterestCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of foregone interest that exceeded the interest cap amount. This is only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable to loans that had "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalInterestCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at loan origination."},"children":[]}]}]}],"format":"float","type":"number"},"forgoneInterestDeferredAmount":{"description":"The amount of interest that was foregone because of deferred\ninterest promotions.\nThis is only applicable to loans with deferred interest\npromotions that were not executed.\n","format":"float","type":"number"},"forgoneInterestRoundingAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of interest that was forgone because of rounding. Applicable only to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lines of credit (and draws) with minimum payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lines of credit (and draws) with balloon amortization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment loans with balloon amortization"},"children":[]}]}]}]}],"format":"float","type":"number"},"interestAccruedTotalAmount":{"description":"The total interest accrued - net of interest discount and foregone interest - from the start of the loan to the date of inquiry.","format":"float","type":"number"},"interestAccruedYearToDateAmount":{"description":"The amount of interest accrued year-to-date not including interest discounts and forgone interest.\n","format":"float","type":"number"},"interestAccruedYearToDateForStatementAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount should be used for statements. The amount of interest accrued year-to-date not including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest discounts and forgone interest."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Peach system accrues interest on a \"following\" day based on the principal balance at the end-of-day of a prior day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest effective date is the \"following\" day. For example, interest that accrues on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"principal balance at the end-of-day of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2021-12-13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The interest is effectively booked to the ledger on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When summarizing year to date interest for a statement, the interest that was accrued effectively on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be part of the 2021 year (in the example above). This is the main difference between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAccruedYearToDateAmount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAccruedYearToDateForStatementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"format":"float","type":"number"},"interestDiscountTotalAmount":{"description":"The total interest discount from the start of the loan to the date of inquiry.","format":"float","type":"number"}},"type":"object"},"loanStatus":{"$ref":"#/components/schemas/LoanStatus"},"nonAccrualBalances":{"description":"Non-accrual balances represent balances that are non-accrual.","properties":{"nonAccrualFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonAccrualInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonAccrualPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"nonAccrualTotalAmount":{"description":"The total non-accrual balance sums non-accrual principal, interest, and fees.","format":"float","type":"number"}},"type":"object"},"nonDueBalances":{"$ref":"#/components/schemas/NonDueBalances"},"openToBuyAmount":{"$ref":"#/components/schemas/OpenToBuyAmount"},"outstandingBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a loan is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", outstanding balances combine non-due, due, and overdue balances. When a loan is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", outstanding balances are equal to non-accrual balances. When a loan is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outstanding balances are equal to charged-off balances."},"children":[]}]}]}],"properties":{"outstandingDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingOriginationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingDrawFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingLateFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingModificationFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingMembershipFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingMembershipFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total outstanding balance sums outstanding principal, interest, and fees. Also called the loan payoff amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan is charged off, the outstanding totalAmount will be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"outstandingBalancesWithPromo":{"description":"Promotional balances represent various balances needed to be paid in order to exercise the same-as-cash or\nother promotional program.\n","properties":{"outstandingTotalAmount":{"description":"The remaining amount needed to be paid in order to exercise the same-as-cash or other promotional program.\n","format":"float","nullable":true,"type":"number"}},"type":"object"},"overLimitAmount":{"$ref":"#/components/schemas/OverLimitAmount"},"overdueBalances":{"$ref":"#/components/schemas/OverdueBalances"},"overdueNumberDays":{"description":"If the loan is currently overdue, this represents the number of days the loan has been overdue.","type":"integer"},"paidBalances":{"description":"Paid balances represent the amounts paid to date.","properties":{"paidCreditsAmount":{"description":"The total amount of service credits applied to the loan until today.","format":"float","type":"number"},"paidFeesAmount":{"description":"The total amount of fees paid until today.","format":"float","type":"number"},"paidInterestAmount":{"description":"The total amount of interest paid until today.","format":"float","type":"number"},"paidOverAmount":{"description":"Stores any excess amount that was not allocated to principal, interest or fees.","format":"float","type":"number"},"paidPaymentsAmount":{"description":"The total amount of payments applied to the loan until today, excluding reimbursements.","format":"float","type":"number"},"paidPrincipalAmount":{"description":"The total amount of principal paid until today.","format":"float","type":"number"},"paidReimbursementsAmount":{"description":"The total amount of reimbursements applied to the loan until today.","format":"float","type":"number"},"paidTotalAmount":{"description":"The total payment and service credits made from the start of the loan to the date of inquiry. Excludes reimbursements.","format":"float","type":"number"}},"type":"object"},"reimbursementAmount":{"description":"The total amount that a lender owes to the borrower. After a reimbursement is processed, the amount is reduced accordingly.\n","format":"float","type":"number"},"utilizationAmount":{"$ref":"#/components/schemas/UtilizationAmount"}},"type":"object"}]}},"components/schemas/FutureBalances":{"id":"components/schemas/FutureBalances","kind":"json-schema","title":"FutureBalances","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"description":"The projected loan balances as of the time of inquiry.","properties":{"expectedTotalAmount":{"description":"The total amount the borrower is projected to pay under the assumption of continued on-time payments.\n","format":"float","type":"number"},"projectedPayoffDate":{"description":"Date for when the loan is expected to be paid off, assuming current balances and expected payments or autopays.\n","format":"date","type":"string"},"projectedTotalDueBalanceTenDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the projected loan total due balance in 10 calendar days from today. The difference between today's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the estimate in 10 days is only the interest that would accrue on the loan."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}]}},"components/schemas/LoanTypeCompanyConfigOverride":{"id":"components/schemas/LoanTypeCompanyConfigOverride","kind":"json-schema","title":"Loan Type Company Config Override","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as the company config, but stored on a loan type object, allowing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for overriding a subset of global settings on a per-loan-type basis."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is not configured at the loan type level, the system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fall back to the company-level configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Any property can be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the override and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fall back to the company-level configuration for that specific property."},"children":[]}]}]}],"properties":{"brandAssets":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigBrandAssets"}],"nullable":true},"brandName":{"description":"The name of the company for presentation to the end consumer\n(same as company.brandName)\n","nullable":true,"type":"string"},"collections":{"additionalProperties":false,"nullable":true,"properties":{"autoInitiate":{"additionalProperties":false,"nullable":true,"properties":{"enableReviewTask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, when a collection case is created automatically,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a task of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewAutoCreatedCase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taskrouter—the assumption being that usually a human should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"review automatically created cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable the creation of this task set this config to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"boolean"}},"type":"object"}},"type":"object"},"legalName":{"description":"Legal name of the company (same as company.legalName)","nullable":true,"type":"string"},"links":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigLinks"}],"nullable":true},"openHours":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigOpenHours"}],"nullable":true},"showPoweredByPeach":{"description":"Corresponds to /bootstrap.company.showPoweredByPeach.\nControls whether to show \"Powered by Peach\" branding.\n","nullable":true,"type":"boolean"},"support":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigSupport"}],"nullable":true},"timezone":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigTimezone"}],"nullable":true},"ui":{"allOf":[{"$ref":"#/components/schemas/CompanyConfigUi"}],"nullable":true}},"title":"Loan Type Company Config Override","type":"object"}},"components/schemas/CreditAgenciesIdentifiers":{"id":"components/schemas/CreditAgenciesIdentifiers","kind":"json-schema","title":"CreditAgenciesIdentifiers","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can report to one or more credit reporting agencies. Make sure to set identifiers for each agency you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan to report in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metro2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint sets identifiers for loans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka portfolio). If you have more than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one loan type (meaning different portfolios), you need to create identifiers for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, you need to create file upload details using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create credit agency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each credit agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file upload details need to be set once per credit agency, and all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka all portfolios)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be uploaded to the same location."},"children":[]}]}]}],"properties":{"isCreditReportingAllowed":{"type":"boolean"},"metro2":{"properties":{"accountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00–05,10,11,13,17,20,90,91,95,0A, 3A, 6A, 9A, 7B, 0F"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOC:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15, 43, 47, 7A, 9B"},"children":[]}]}]}],"maxLength":2,"type":"string"},"creditorClassification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creditor Classification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01=Retail"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02=Medical/Health Care"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when reporting medical debts and returned checks from providers of medical services, products or devices"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03=Oil Company"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04=Government"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05=Personal Services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"06=Insurance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07=Educational"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"08=Banking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"09=Rental/Leasing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10=Utilities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11=Cable/Cellular"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12=Financial"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(other non-banking financial institutions)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13=Credit Union"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"14=Automotive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15=Check Guarantee"},"children":[]}]}]}],"enum":["01","02","03","04","05","06","07",8,9,"10","11","12","13","14","15"],"maxLength":2,"type":"string"},"equifaxIdentificationNumber":{"description":"Equifax Identification number.\n","maxLength":20,"type":"string"},"equifaxProgramIdentifier":{"description":"Equifax program identifier.\nThis is a String of 10 chars.\n","maxLength":10,"type":"string"},"experianIdentificationNumber":{"description":"Experian Identification number.\n","maxLength":20,"type":"string"},"experianProgramIdentifier":{"description":"Experian program identifier.\nThis is a String of 5 chars.\n","maxLength":5,"type":"string"},"innovisIdentificationNumber":{"description":"Innovis Identification number.\n","maxLength":20,"type":"string"},"innovisProgramIdentifier":{"description":"Innovis program identifier.\nThis is a String of 10 chars.\n","maxLength":10,"type":"string"},"interestTypeIndicator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest type indicator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the interest is reported as fixed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"V"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the interest is reported as variable/adjustable"},"children":[]}]}]}],"maxLength":1,"type":"string"},"microBiltPrbcProgramIdentifier":{"description":"MicroBilt/PRBC program identifier.\n","maxLength":10,"type":"string"},"portfolioType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portfolio type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C=Line of Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"I=Installment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M=Mortgage"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O=Open"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R=Revolving"},"children":[]}]}]}],"enum":["C","I","M","O","R"],"maxLength":1,"type":"string"},"reporterAddress":{"description":"Reporter address.\nThis is a String of 96 chars.\n","maxLength":96,"type":"string"},"reporterName":{"description":"Reporter name.\nThis is a String of 40 chars.\n","maxLength":40,"type":"string"},"reporterTelephoneNumber":{"description":"Reporter telephone number.\n","maxLength":10,"type":"string"},"roundingMethod":{"default":"roundDownWhole","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monetary fields are reported in whole dollars only in Metro2."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roundUpWhole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an amount will be rounded up to the nearest dollar. For example: $4.02 -> $5."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roundDownWhole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an amount will be rounded down to the nearest dollar with one exception:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the amount is less than one dollar, the system will report it as one dollar vs. zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: $1.98 -> $1, $0.03 -> $1."},"children":[]}]}]}]}],"enum":["roundDownWhole","roundUpWhole"],"type":"string"},"skipSegments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segments excluded from Metro2. The reported data depends on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan type configuration. If the loan type specifies a segment to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be skipped, the segment will not be reported even if the loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details include it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: If a lender sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metro2.reportK2Segment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when a loan is assigned to a debt collection agency or investor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has changed but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"k2Segment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the K2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segment won't be reported"},"children":[]}]}]}],"items":{"enum":["header","baseSegment","k1Segment","k2Segment","l1Segment"],"type":"string"},"type":"array"},"softwareVendorName":{"default":"Peach Finance Inc.","description":"Software vendor name.\n","maxLength":40,"type":"string"},"softwareVersionNumber":{"default":"1.1","description":"Software version number.\n","maxLength":5,"type":"string"},"transunionIdentificationNumber":{"description":"TransUnion Identification number.\n","maxLength":20,"type":"string"},"transunionProgramIdentifier":{"description":"TransUnion program identifier.\nThis is a String of 10 chars.\n","maxLength":10,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/DayType":{"id":"components/schemas/DayType","kind":"json-schema","title":"DayType","data":{"description":"Whether day field refers to weekends and holidays or only business days.","enum":["business","calendar"],"type":"string"}},"components/schemas/BalanceCheck":{"id":"components/schemas/BalanceCheck","kind":"json-schema","title":"BalanceCheck","data":{"description":"Balance check configuration","nullable":true,"properties":{"checkOffsetDays":{"description":"Number of days before payment to check for the balance","minimum":0,"type":"integer"},"debitLogic":{"items":{"properties":{"action":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Debit the account. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reschedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The system will reschedule the payment to \"payment due date + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rescheduleBufferInDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\". "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cancel the payment."},"children":[]}]}]}],"enum":["cancel","debit","reschedule"],"type":"string"},"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceNA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the payment method used cannot check balances. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: debit card or bank account that was never connected to a balance check (or was disconnected manually by the borrower)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It means that \"account link\" status is \"inactive\" or the account link object is empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceBroken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - there is a balance connection object, but it's broken - due to an error. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It means that \"account link\" status is \"active\", but there is an errorCode exists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceGreen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - account balance is more than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceYellow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and significantly more than the scheduled amount."},"children":[]}]}]}],"enum":["balanceNA","balanceBroken","balanceRed","balanceYellow","balanceGreen"],"type":"string"}},"type":"object"},"type":"array"},"enabled":{"description":"If enabled, balance check will be performed based on the configuration prior to processing bank account payments.","type":"boolean"},"rescheduleBufferDayType":{"$ref":"#/components/schemas/DayType"},"rescheduleBufferInDays":{"description":"Number of days buffer to reschedule the payment.","type":"integer"},"thresholds":{"items":{"properties":{"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage value for the specified zone (1 = 100% of the scheduled payment, 1.2 = 120% of the scheduled payment, etc.)."},"children":[]}]}]}],"format":"float","type":"number"},"zone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Thresholds represented as multiple of the scheduled payment amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceRed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - account balance is less than scheduled amount. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceYellow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - account balance is more than the scheduled amount but not by much. \\"},"children":[]}]}]}],"enum":["balanceRed","balanceYellow"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/MultiLoanPaymentWaterfall":{"id":"components/schemas/MultiLoanPaymentWaterfall","kind":"json-schema","title":"MultiLoanPaymentWaterfall","data":{"properties":{"loansOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"highestInterestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan or draw with the highest interest rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lowestInterestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan or draw with the lowest interest rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldestLoanDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the oldest loan or draw"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newestLoanDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the newest loan or draw"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"highestOutstandingBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan or draw with the highest outstanding balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lowestOutstandingBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan or draw with the lowest outstanding balance"},"children":[]}]}]}],"items":{"enum":["highestInterestRate","lowestInterestRate","oldestLoanDate","newestLoanDate","highestOutstandingBalance","lowestOutstandingBalance","activeFirst","chargedOffFirst"],"type":"string"},"type":"array"},"transactionType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment made by the borrower or by a service agent per borrower request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be one-time payment, future payment or Autopay."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful payments reduce loan balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - service credit issued by a service agent or supervisor. Successful service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credits reduce loan balance."},"children":[]}]}]}],"enum":["payment","serviceCredit"],"type":"string"}},"type":"object"}},"components/schemas/BalancesEnum":{"id":"components/schemas/BalancesEnum","kind":"json-schema","title":"BalancesEnum","data":{"enum":["overdueFee","overdueAccruedInterest","overduePrincipal","dueFee","dueAccruedInterest","duePrincipal","nonDueFee","nonDueAccruedInterest","nonDuePrincipal","chargedOffPrincipal","chargedOffAccruedInterest","chargedOffFee","nonAccrualFee","nonAccrualInterest","nonAccrualPrincipal"],"type":"string"}},"components/schemas/SingleLoanPaymentWaterfall":{"id":"components/schemas/SingleLoanPaymentWaterfall","kind":"json-schema","title":"SingleLoanPaymentWaterfall","data":{"properties":{"balancesOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When loan is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the following buckets are relevant for waterfall:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueAccruedInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overduePrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueAccruedInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duePrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueAccruedInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDuePrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When loan is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the following buckets are relevant for waterfall:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffAccruedInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When loan is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the following buckets are relevant for waterfall:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonAccrualFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During payment application, when any fee bucket is reached (nonDueFee, dueFee, etc.), fees in that bucket are paid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on the order defined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feesOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BalancesEnum"},"type":"array"},"feesOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of fees during payment application. When any fee bucket is reached"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(nonDueFee, dueFee, etc.) during payment application, fees in that bucket are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid down in the order defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feesOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modificationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bucket includes the following fee types:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignTransactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modificationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nsfFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feesOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted or an empty list, the default order is applied:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modificationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lateFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"membershipFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"enum":["originationFee","drawFee","modificationFee","lateFee","membershipFee"],"type":"string"},"type":"array"},"loanStatus":{"enum":["active","accelerated","chargedOff"],"type":"string"},"transactionType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment made by the borrower or by a service agent per borrower request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be one-time payment, future payment or Autopay."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful payments reduce loan balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - service credit issued by a service agent or supervisor. Successful service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credits reduce loan balance."},"children":[]}]}]}],"enum":["payment","serviceCredit"],"type":"string"}},"type":"object"}},"components/schemas/PaymentWaterfall":{"id":"components/schemas/PaymentWaterfall","kind":"json-schema","title":"PaymentWaterfall","data":{"properties":{"multi":{"description":"Multiple loans (or draws for Line-of-Credit loans) payment waterfall application\n","items":{"$ref":"#/components/schemas/MultiLoanPaymentWaterfall"},"type":"array"},"single":{"description":"Single loan payment waterfall application.\n","items":{"$ref":"#/components/schemas/SingleLoanPaymentWaterfall"},"type":"array"}},"type":"object"}},"components/schemas/LoanType":{"id":"components/schemas/LoanType","kind":"json-schema","title":"LoanType","data":{"description":"A Loan Configuration is a representation of a Loan Product and its specific\nsettings and configurations\n","properties":{"assetDisplayName":{"description":"The asset display name. For example: Loan, Line of Credit, Lease, Credit Card.\n","maxLength":50,"minLength":0,"type":"string"},"assetType":{"$ref":"#/components/schemas/LoanAssetType"},"automatedDebtValidationNotification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some states require automatic debt validation notices to be sent to borrowers. We are aware of in the following states: Illinois, Maryland, Massachusetts, Minnesota, Nevada, Tennessee, Wyoming, Arizona, Puerto Rico, DC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach can automatically send the debt validation notices based on two triggers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On loan activation event - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The notice will be sent (once) when a loan is activated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On first overdue event - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanFirstOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The notice will be sent (once) when a loan becomes overdue for the first time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please configure which of the states you'd like to elect into receiving the automatic debt validation notice. Use the option where the state is left blank to specify the default option for remaining states (or remove the \"catch all\" entirely)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is an example with a list of states and corresponding templates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  [\"IL\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"MD\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"MA\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"MN\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"NV\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"TN\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"WY\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"AZ\", \"US\", \"ArizonaDebtValidationNotice\", \"loanActivation\"],\n  [\"PR\", \"US\", \"PuertoRicoDebtValidationNotice\", \"loanFirstOverdue\"],\n  [\"\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  [\"IL\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"MD\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"MA\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"MN\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"NV\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n  [\"TN\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"WY\", \"US\", \"debtValidationNoticeAutomatic\", \"loanActivation\"],\n  [\"AZ\", \"US\", \"ArizonaDebtValidationNotice\", \"loanActivation\"],\n  [\"PR\", \"US\", \"PuertoRicoDebtValidationNotice\", \"loanFirstOverdue\"],\n  [\"\", \"US\", \"debtValidationNoticeAutomatic\", \"loanFirstOverdue\"],\n]\n"},"children":[]}]}],"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of three or four elements mapping a state to a debt validation notice template and trigger."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only three elements are included the fourth is assumed to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"loanActivation\""},"children":[]}]}]}],"example":["IL","US","debtValidationNoticeAutomatic","loanActivation"],"items":{"type":"string"},"type":"array"},"type":"array"},"companyConfigOverride":{"$ref":"#/components/schemas/LoanTypeCompanyConfigOverride","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company config override for this loan type. This field is only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=companyConfigOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query parameters. Otherwise, it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"creditReporting":{"$ref":"#/components/schemas/CreditAgenciesIdentifiers"},"currency":{"default":"USD","description":"The currency used in loans of this type.","type":"string"},"description":{"description":"An optional description for the loan product","nullable":true,"type":"string"},"externalId":{"description":"An optional client unique identifier for the loan product","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"extraFields":{"additionalProperties":true,"nullable":true,"type":"object"},"fees":{"properties":{"originationFeeAPRCalcOverride":{"default":"noOverride","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the APR will be calculated as if the origination fee will be calculated per the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFeeChargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the APR will be calculated as if origination fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was collected at origination regardless of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFeeChargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["noOverride","atOrigination"],"type":"string"},"originationFeeChargeLogic":{"$ref":"#/components/schemas/FeeChargeLogic"},"originationFeeDisplayName":{"default":"Origination Fee","description":"The display name of the origination fee as shown to the borrower in the UI. For example: \"Origination fee\" or \"Set up fee\".\n","type":"string"}},"type":"object"},"forceCaseIdOnAgentActions":{"default":true,"description":"If true, a loan action made by an agent must come with a case ID.","type":"boolean"},"futurePay":{"properties":{"achDebitTiming":{"enum":["initiateOnDueDate","hitOnDueDate"],"type":"string"},"achDebitTimingShiftOnNonBusinessDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls ACH transaction creation timing when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay.achDebitTiming=\"hitOnDueDate\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not applicable for transaction types other than ACH or when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay.achDebitTiming=\"initiateOnDueDate\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["forward","backward"],"type":"string"},"balanceCheck":{"$ref":"#/components/schemas/BalanceCheck"},"overpaymentAmountLimitFactor":{"default":1.5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier will be used to calculate the maximum amount allowed to be scheduled as one-time payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is 1.2 and the current outstanding balance is $200.00. The maximum amount that a one-time payment is allowed is $200.00 * 1.2 = $240.00"},"children":[]}]}]}],"format":"float","minimum":1,"type":"number"}},"type":"object"},"loanBalancesFastFields":{"description":"Optional list of balance field names used to populate fast/real-time balance lookups.","items":{"type":"string"},"nullable":true,"type":"array"},"managedByPeach":{"description":"If true, this loan will be completely managed by the system including amortization, interest accrual etc.","type":"boolean"},"name":{"description":"An optional name for the loan product","maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openToBuyCalculation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the lender's configuration to determine the \"Open to Buy\" amount. Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineOfCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"calculationType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This calculation determines whether transactions' "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used when calculating open-to-buy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionStatus - open-to-buy will take into account transaction status only. Open-to-buy will not be adjusted if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction status is in [initiated, pending] regardless of the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionHoldDays - open-to-buy will take into account transaction hold days only. Open-to-buy will not be adjusted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the transaction status is in [initiated, pending, succeeded] AND the transaction is within holdDaysEndDate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionStatusAndHoldDays - Open-to-buy will take into account transaction status and hold days period. Open-to-buy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will not be adjusted if the transaction status is in [initiated, pending] AND the transaction is within hold days periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openToBuyCalculation=transactionStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tx status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within hold days window"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after hold days window"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openToBuyCalculation=transactionHoldDays"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tx status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within hold days window"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after hold days window"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openToBuyCalculation=transactionStatusAndHoldDays"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tx status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within hold days window"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after hold days window"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy not adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open-to-buy adjusted"},"children":[]}]}]}]}]}]}],"enum":["transactionStatus","transactionHoldDays","transactionStatusAndHoldDays"],"type":"string"}},"type":"object"},"paydayNotices":{"properties":{"sendConsumerRightsNotice":{"default":false,"description":"Indicates if the system should send Payday Consumer Rights Notice to the Borrower via email after two consecutive\nfailed debit attempts.\n","type":"boolean"},"sendFirstPaymentWithdrawalNotice":{"default":false,"description":"Indicates if the system should send Payday First Payment Withdrawal Notice to the Borrower via email and text message at\nleast 3 business days prior to the scheduled payment.\n","type":"boolean"}},"type":"object"},"paymentAllowedWhenChargedOff":{"default":false,"type":"boolean"},"paymentHoldDays":{"$ref":"#/components/schemas/PaymentHoldDays"},"paymentWaterfall":{"$ref":"#/components/schemas/PaymentWaterfall"},"refunds":{"properties":{"isRefundAllowed":{"description":"Whether a borrower can receive a refund.","type":"boolean"}},"type":"object"},"snapshots":{"description":"Loan daily snapshots","properties":{"reportDaysWhenPaidOff":{"default":10,"minimum":10,"type":"integer"}},"type":"object"},"status":{"description":"The status of the loan type","enum":["inactive","active"],"type":"string"},"timezone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional timezone configuration for the loan type, represented as a valid tz code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string such as \"UTC\" or \"America/Los_Angeles\". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the timezone defaults to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timezone configuration on the company."},"children":[]}]}]}],"nullable":true,"type":"string"},"txDescriptorAssetDisplayName":{"default":"Loan","description":"Text that will be used in transaction descriptor.\nThe descriptor is shown in customer online bank account or statement.\nThe text must be limited to 4 characters. If more than 4 characters are set, the logic will trim the text and use only first 4 characters.\nFor example: LOAN, LINE, CARD, PLAN, etc. The full description will look like: LOAN PYMT, CARD PYMT.\n","type":"string"},"useExternalIdInUI":{"type":"boolean"}},"required":["assetType","assetDisplayName"],"type":"object"}},"components/schemas/NameNotNullable":{"id":"components/schemas/NameNotNullable","kind":"json-schema","title":"NameNotNullable","data":{"description":"Name of the person.","nullable":false,"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"current":{"default":true,"description":"Name is flagged as current.","readOnly":true,"type":"boolean"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"effectiveAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"firstName":{"description":"A person's first name.","maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"string"},"lastName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's last name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"maxLength":50,"type":"string"},"maidenLastName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's maiden name, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"J."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"nullable":true,"type":"string"},"middleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's middle name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacted to the first initial (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"maxLength":50,"nullable":true,"type":"string"},"object":{"default":"name","enum":["name"],"readOnly":true,"type":"string"},"originalValue":{"description":"The original value for name before an update.","readOnly":true,"type":"object"},"preferredFirstName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's preferred first name. This name will be used for interactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"like emails, text messages, outbound calls, online portal, etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no preferred name is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"nullable":true,"type":"string"},"prefix":{"description":"A person's name prefix.","nullable":true,"type":"string"},"source":{"enum":["peach","lender","externalAPI"],"readOnly":true,"type":"string"},"status":{"enum":["active","inactive"],"readOnly":true,"type":"string"},"suffix":{"description":"A person's name suffix.","maxLength":5,"nullable":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"required":["firstName","lastName"],"type":"object"}},"components/schemas/PersonNoIdentity":{"id":"components/schemas/PersonNoIdentity","kind":"json-schema","title":"Person","data":{"allOf":[{"$ref":"#/components/schemas/BasePersonNoIdentity"},{"properties":{"dateOfBirth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of birth."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"name":{"$ref":"#/components/schemas/NameNotNullable"},"object":{"default":"person","enum":["person"],"readOnly":true,"type":"string"}},"type":"object"}],"title":"Person"}},"components/schemas/IdentityBase":{"id":"components/schemas/IdentityBase","kind":"json-schema","title":"IdentityBase","data":{"description":"The borrower's identifier. For example, the Social Security number.\n","properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"customIdentityTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a personal or business ID. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityType=customID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This needs to be \"one word\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only US (a-zA-Z) letters. No numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: Metrica Consular Card for Mexicans living abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityType=customID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customIdentityTypeName=metricaConsularCard"},"children":[]}]}]}]}],"maxLength":50,"minLength":1,"pattern":"^[a-zA-Z]+$","type":"string"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"expirationDate":{"description":"Date the identification expires.\n","format":"date","nullable":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"identityType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal and business identifiers that are supported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for personal or business IDs that are not explicitly listed as one of the enum values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityType=customID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customIdentityTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: Metrica Consular Card for Mexicans living abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityType=customID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customIdentityTypeName=metricaConsularCard"},"children":[]}]}]}]}],"enum":["SSN","ITIN","passport","driversLicense","taxID","FEIN","stateID","customID"],"type":"string"},"issueDate":{"description":"Date the identification was issued.\n","format":"date","nullable":true,"type":"string"},"issuingCountry":{"default":"","description":"Country that issued the identification. English short name according to ISO 3166-1 standard.\n","type":"string"},"object":{"default":"identity","enum":["identity"],"readOnly":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"valid":{"default":true,"description":"Whether the identity is valid.\n","type":"boolean"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a personal identifier. For example, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"123456789"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/IdentityPut":{"id":"components/schemas/IdentityPut","kind":"json-schema","title":"IdentityPut","data":{"allOf":[{"$ref":"#/components/schemas/IdentityBase"},{"properties":{"isArchived":{"description":"Determines whether the identity has been archived. By default, only non-archived\nidentities are shown. Cannot be changed for primary identities.\n","type":"boolean"}},"type":"object"}]}},"components/schemas/Identity":{"id":"components/schemas/Identity","kind":"json-schema","title":"Identity","data":{"allOf":[{"$ref":"#/components/schemas/IdentityPut"},{"properties":{"isPrimary":{"default":false,"description":"Whether the identity is the borrower's primary identity or not. A borrower may\nonly have one primary identity. Primary identities can be created when\ncreating a borrower, or separately.\n","type":"boolean"}},"type":"object"}]}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"allOf":[{"$ref":"#/components/schemas/PersonNoIdentity"},{"properties":{"identities":{"items":{"$ref":"#/components/schemas/Identity"},"readOnly":true,"type":"array"},"identity":{"allOf":[{"$ref":"#/components/schemas/IdentityBase"},{"required":["identityType","value"],"type":"object","writeOnly":true}]},"redactedFields":{"$ref":"#/components/schemas/RedactedFields"}},"required":["name"],"type":"object"}],"title":"Person"}},"components/schemas/BusinessDetails":{"id":"components/schemas/BusinessDetails","kind":"json-schema","title":"BusinessDetails","data":{"description":"The business details.","properties":{"businessLegalName":{"description":"The business' legal name.","type":"string"},"businessName":{"description":"The business' name or DBA.","type":"string"},"businessType":{"description":"The business type.","enum":["LLC","cCorporation","sCorporation","generalPartnership","limitedPartnership","soleProprietor","nonProfit","other","cooperative","independentContractor","selfEmployed","veteransOrganization","tribalBusiness","soleTrader","incorporatedAssociation","unincorporatedAssociation","trust","unitTrust","appointorTrust"],"type":"string"},"incorporatedCountry":{"description":"The country where the business was incorporated or organized. English short name according to ISO 3166-1 standard.","type":"string"},"incorporatedState":{"description":"The state or province code (not full name) where the business was incorporated or organized. For example: CA.\n","type":"string"}},"required":["businessType","businessName","businessLegalName"],"type":"object"}},"components/schemas/BusinessNoIdentity":{"id":"components/schemas/BusinessNoIdentity","kind":"json-schema","title":"Business","data":{"allOf":[{"$ref":"#/components/schemas/BasePersonNoIdentity"},{"properties":{"businessDetails":{"$ref":"#/components/schemas/BusinessDetails"},"object":{"default":"business","enum":["business"],"readOnly":true,"type":"string"}},"required":["businessDetails"],"type":"object"}],"title":"Business"}},"components/schemas/Business":{"id":"components/schemas/Business","kind":"json-schema","title":"Business","data":{"allOf":[{"$ref":"#/components/schemas/BusinessNoIdentity"},{"properties":{"identities":{"items":{"$ref":"#/components/schemas/Identity"},"readOnly":true,"type":"array"},"identity":{"allOf":[{"$ref":"#/components/schemas/IdentityBase"},{"required":["identityType","value"],"type":"object","writeOnly":true}]},"redactedFields":{"$ref":"#/components/schemas/RedactedFields"}},"type":"object"}],"title":"Business"}},"components/schemas/Borrower":{"id":"components/schemas/Borrower","kind":"json-schema","title":"Borrower","data":{"anyOf":[{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/Business"}]}},"components/schemas/TransactionCancelReason":{"id":"components/schemas/TransactionCancelReason","kind":"json-schema","title":"TransactionCancelReason","data":{"default":"canceledByUser","description":"Why the transaction was canceled.","enum":["invalidPaymentMethod","paymentMethodRemoved","tooManyFailedAttempts","loanFrozen","loanAccelerated","loanChargedOff","loanPaidOff","canceledByUser","loanTermsChanged","balanceCheckThresholdExceeded"],"nullable":true,"type":"string"}},"components/schemas/HoldDaysEndDate":{"id":"components/schemas/HoldDaysEndDate","kind":"json-schema","title":"HoldDaysEndDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows lenders to configure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calculation. Peach's system will not include the transaction in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calculation until this date (in the product timezone). For example, if a transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is tomorrow or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"later, the transaction will NOT be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuyAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this value will override "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan.paymentHoldDays.numHoldDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.paymentHoldDays.numHoldDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not set upon transaction create, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be calculated based on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan.paymentHoldDays.numHoldDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan.paymentHoldDays.numHoldDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not set, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdDaysEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be calculated based on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.paymentHoldDays.numHoldDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will only apply to borrower payments and is not applicable for other types of transactions (e.g. service credits)"},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"}},"components/schemas/TransactionStatus":{"id":"components/schemas/TransactionStatus","kind":"json-schema","title":"TransactionStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was scheduled for a future date that has not arrived yet. The payment has not applied to a loan yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment failed and was removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then. Disputed payment can be for partial amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was canceled. Payment can be canceled only if the current status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to create or update transactions to have status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create transaction chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Update chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints should be used."},"children":[]}]}]}],"enum":["scheduled","initiated","pending","succeeded","failed","canceled"],"type":"string"}},"components/schemas/BaseTransaction":{"id":"components/schemas/BaseTransaction","kind":"json-schema","title":"Transaction","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"achConfirmed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to ACH transactions processed by Peach. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the originating bank has confirmed receipt of the transaction."},"children":[]}]}]}],"nullable":true,"readOnly":true,"type":"boolean"},"achProcessedSameDay":{"description":"The transaction was processed with ACH Same Day.\n","nullable":true,"readOnly":true,"type":"boolean"},"achReturnCode":{"description":"The ACH return code indicating the reason the transaction failed.","maxLength":5,"type":"string"},"achSameDay":{"description":"Attempt to process this transaction with ACH Same Day processing.\n","nullable":true,"readOnly":true,"type":"boolean"},"actualAmount":{"description":"The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n","format":"float","type":"number"},"avsResult":{"maxLength":1,"minLength":1,"type":"string"},"cancelLongDescription":{"description":"More detailed reason why the transaction was canceled.\n","readOnly":true,"type":"string"},"cancelReason":{"$ref":"#/components/schemas/TransactionCancelReason"},"cancelShortDescription":{"description":"Brief reason why the transaction was canceled.\n","readOnly":true,"type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the transaction.\nCan be an borrower, agent, or automated system process.\n"},"currency":{"description":"Currency of the transaction.","pattern":"[A-Z]{3}","type":"string"},"customDisplayName":{"description":"A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements (or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will render the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n","nullable":true,"type":"string"},"failureDescriptionLong":{"description":"Detailed text describing the failure reason and any appropriate actions the user may take to fix the issue.\n","readOnly":true,"type":"string"},"failureDescriptionShort":{"description":"Short text describing the failure reason. Normally displayed in UI.\n","readOnly":true,"type":"string"},"failureReason":{"description":"The transaction failure reason.","enum":["insufficientFunds","chargeback","accountClosed","invalidAccount","unknownReason","invalidCvv","invalidExpirationDate","avsFailed","networkError","cardDeclined","accountFrozen","deceased","invalidRouting","paymentStopped","incorrectNumber","fraudulent","unauthorizedDebit"],"type":"string"},"holdDaysEndDate":{"$ref":"#/components/schemas/HoldDaysEndDate"},"metaData":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"},"parentTransactionId":{"description":"The ID of the real transactions that created this virtual transaction. Only relevant for virtual transactions.","type":"string"},"paymentDetails":{"description":"Payment details.","properties":{"fromInstrument":{"oneOf":[{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"instrumentType":{"enum":["bankAccount"],"type":"string"}},"title":"Bank Account","type":"object"},{"properties":{"cardNumberLastFour":{"description":"The last two, three or four digits of the card number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","example":"1111","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"cardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of card. Requires permission "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["credit","debit"],"type":"string"},"instrumentType":{"enum":["card"],"type":"string"}},"title":"Card","type":"object"},{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"checkNumber":{"description":"The check number","example":"1025","readOnly":true,"type":"string"},"instrumentType":{"enum":["check"],"type":"string"},"routingNumber":{"description":"The check routing number","example":"000000000","readOnly":true,"type":"string"}},"title":"Check","type":"object"},{"properties":{"employerName":{"description":"The employer name","type":"string"},"instrumentType":{"enum":["payroll"],"type":"string"}},"title":"Payroll","type":"object"},{"properties":{"instrumentType":{"enum":["paymentNetwork"],"type":"string"},"paymentNetworkMemberId":{"description":"The borrower identifier in the payment network system.","type":"string"},"paymentNetworkName":{"description":"The payment network name","type":"string"}},"title":"Payment Network","type":"object"},{"properties":{"instrumentType":{"enum":["wire"],"type":"string"},"routingNumber":{"description":"The wire routing number","type":"string"},"wireNumberLastFour":{"description":"The last two, three or four digits of the wire number. Normally, you should expect four digits. Two or three digits are returned when four digits are not available.","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"}},"title":"Wire","type":"object"},{"properties":{"instrumentType":{"enum":["moneyOrder"],"type":"string"},"routingNumber":{"description":"The money order routing number","type":"string"},"serialNumberLastFour":{"description":"The last two, three or four digits of the money order serial number. Normally, you should expect four digits. Two or three digits are returned when four digits are not available.","pattern":"^[0-9]{2,4}","type":"string"}},"title":"Money Order","type":"object"}]},"fromInstrumentId":{"description":"The identifier of the payment instrument that was charged.","pattern":"^ext-|^\\d+$","type":"string"},"reason":{"description":"The reason why the payment was created.","enum":["autoPay","oneTimePayment","settlement","reversal","reimbursement"],"type":"string"},"toInstrument":{"oneOf":[{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"instrumentType":{"enum":["bankAccount"],"type":"string"}},"title":"Bank Account","type":"object"},{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"instrumentType":{"enum":["check"],"type":"string"}},"title":"Check","type":"object"},{"properties":{"employerName":{"description":"The employer name","type":"string"},"instrumentType":{"enum":["payroll"],"type":"string"}},"title":"Payroll","type":"object"},{"properties":{"instrumentType":{"enum":["paymentNetwork"],"type":"string"},"paymentNetworkMemberId":{"description":"The borrower identifier in the payment network system.","type":"string"},"paymentNetworkName":{"description":"The payment network name","type":"string"}},"title":"Payment Network","type":"object"},{"properties":{"instrumentType":{"enum":["wire"],"type":"string"},"routingNumber":{"description":"The wire routing number","type":"string"},"wireNumberLastFour":{"description":"The last two, three or four digits of the wire number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"}},"title":"Wire","type":"object"},{"properties":{"instrumentType":{"enum":["moneyOrder"],"type":"string"},"routingNumber":{"description":"The money order routing number","type":"string"},"serialNumberLastFour":{"description":"The last two, three or four digits of the money order serial number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","type":"string"}},"title":"Money Order","type":"object"}]},"toInstrumentId":{"description":"The identifier of the payment instrument that was credited.","pattern":"^ext-|^\\d+$","type":"string"},"type":{"description":"The payment type.","enum":["ach","debitCard","creditCard","check","cash","payroll","paymentNetwork","moneyOrder","wire"],"type":"string"}},"type":"object"},"processingFeeAmount":{"description":"Transaction processing fees that are charged by a payment processor.","type":"number"},"processingFeeType":{"description":"Describes whether the processing fees are net or gross.\nIf it is a net fee, the amount of the fee is deducted from the amount of the transaction 'en route'.\nIf it is a gross fee, the amount of the fee is charged by the processor at the end the month.\n","enum":["net","gross"],"type":"string"},"processorFailureDetails":{"description":"The error details returned by the payment processor."},"processorFailureReason":{"description":"The raw failure reason returned by the payment processor.","type":"string"},"processorMerchantId":{"description":"Applies to card transactions processed by Peach. The merchant ID used for processing a card transaction.\n","nullable":true,"readOnly":true,"type":"string"},"processorReconciliationId":{"type":"string"},"processorReversalId":{"type":"string"},"processorTransactionId":{"type":"string"},"retryAttempt":{"description":"Number of attempts to retry processing a failed transaction.\n","nullable":true,"type":"integer"},"retryOriginalTransactionId":{"description":"The Peach identifier for the original transaction for which this is a retry.\n","nullable":true,"readOnly":true,"type":"string"},"reversedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of reversals associated with this transaction. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversedByTransactionIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for reversal transaction details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is calculated by Peach and cannot be set or updated via API."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"reversedByTransactionExternalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversedByTransactionIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain external IDs of all reversing transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lender's external identifier of the transaction that reverses this one."},"children":[]}]}]}],"pattern":"^ext-|^\\d+$","readOnly":true,"type":"string"},"reversedByTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversedByTransactionIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain IDs of all reversing transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach identifier of the transaction that reverses this one."},"children":[]}]}]}],"readOnly":true,"type":"string"},"reversedByTransactionIds":{"description":"Identifier(s) of the transaction(s) that reverse this one","items":{"properties":{"externalId":{"description":"Lender's external identifier of the transaction that reverses this one.","pattern":"^ext-|^\\d+$","type":"string"},"id":{"description":"Peach identifier of the transaction that reverses this one","type":"string"}},"type":"object"},"readOnly":true,"type":"array"},"reversesTransactionExternalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the original transaction that is being fully or partially reversed by this transaction."},"children":[]}]}]}],"readOnly":true,"type":"string"},"reversesTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the original transaction that is being fully or partially reversed by this transaction."},"children":[]}]}]}],"readOnly":true,"type":"string"},"scheduledAmount":{"description":"The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n","format":"float","type":"number"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"timestamps":{"description":"Timestamps of the transaction statuses.","properties":{"appliedAt":{"description":"The effective date and time the transaction was applied to the loan.\nThis matches the effective date and time of the ledger entries resulting from applying the transaction.\nIf this value is null, the transaction has not been applied.\n","format":"date-time","readOnly":true,"type":"string"},"canceledAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"chargebackAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"createdAt":{"description":"The date and time the transaction was created.\n","format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"description":"If this field is not null, the transaction is considered deleted. The date and time the transaction was deleted.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"displayDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display date of the transaction in the product timezone."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This determines the placement of the transaction on the timeline displayed in the borrower portal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some instances, this will differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction. For example, when a reversal transaction is created,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the reversal matches the original transaction, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the reversal is the date on which the reversal was processed."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveDate":{"description":"The effective date of the transaction in the product timezone. Updated when a transaction is backdated.","format":"date","type":"string"},"failedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"inDisputeAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"initiatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"originalDisplayDate":{"format":"date","readOnly":true,"type":"string"},"originalEffectiveDate":{"description":"The original effective date of the transaction in the product timezone, prior to any backdating of the transaction.","format":"date","readOnly":true,"type":"string"},"pendingAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"scheduledDate":{"description":"The scheduled date of the transaction in the product timezone.\nTransactions to be processed by peach will be processed on this date.\n","format":"date","type":"string"},"succeededAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the transaction transitioned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date-time","type":"string"},"updatedAt":{"description":"The date and time the transaction was last updated.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"transactionType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment made by the borrower or by a service agent per borrower request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be one-time payment, future payment or Autopay."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful payments reduce loan balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - service credit issued by a service agent or supervisor. Successful service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credits reduce loan balance."},"children":[]}]}]}],"enum":["payment","serviceCredit"],"type":"string"}},"type":"object"}],"title":"Transaction"}},"components/schemas/ChargebackStatus":{"id":"components/schemas/ChargebackStatus","kind":"json-schema","title":"ChargebackStatus","data":{"default":"open","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the chargeback."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  the chargeback was opened and is currently in dispute. The system assumes that the chargeback amount is temporarily taken and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction is reduced by the chargeback amount. This might trigger a replay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the chargeback dispute period has closed, and the chargeback has been upheld. This is a terminal state and the chargeback cannot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be reopened. The system assumes that the chargeback amount is permanently taken and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction is reduced."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the chargeback dispute period has closed, and the chargeback has been reversed. The system assumes that the chargeback amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is permanently returned and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction is increased back. This might trigger a replay."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeback status impacts the transaction status is the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a transaction with a single chargeback, the chargeback status dictates the transaction status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:inDispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:chargeback"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:reversed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a transaction with multiple chargebacks, the following logic applied:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any of the chargebacks in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:inDispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No chargebacks are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and any chargebacks are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:chargeback"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All chargebacks are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:reversed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"→ transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status:succeeded"},"children":[]}]}]}]}],"enum":["open","closed","reversed"],"type":"string"}},"components/schemas/Chargeback":{"id":"components/schemas/Chargeback","kind":"json-schema","title":"Chargeback","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the chargeback. Defaults to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}],"format":"float","type":"number"},"caseId":{"description":"The identifier of an existing case.","type":"string"},"category":{"description":"The chargeback category as received from the payment processor.","type":"string"},"description":{"description":"The description of the chargeback as received from the payment processor.","type":"string"},"externalCaseNumber":{"description":"The external case number of the chargeback in the payment processor system.","type":"string"},"externalId":{"description":"The lender's identifier of the chargeback.","readOnly":true,"type":"string"},"id":{"description":"The identifier of the chargeback.","readOnly":true,"type":"string"},"reasonCode":{"description":"The reason code as received from the payment processor.","type":"string"},"status":{"$ref":"#/components/schemas/ChargebackStatus"}},"type":"object"}},"components/schemas/serviceCreditTypes":{"id":"components/schemas/serviceCreditTypes","kind":"json-schema","title":"serviceCreditTypes","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of service credit."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceSupervisor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when a lender provides a service credit as a courtesy to a borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: this type of credit is reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when you need to transfer balance from an existing loan or draw to a new one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: this type of credit is reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usuryCap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used by a lender in case interest or fees exceed usury caps. Note: this type of credit is reported to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rewards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used by a lender to convert rewards to a service credit to pay down outstanding balance. Note: this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of credit is reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when a lender settles outstanding balance with a borrower as part of collection efforts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read carefully the difference between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebtNoLoss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" descriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is considered as \"loss\" in Metro2 logic of \"Account Status\" Base Segment field. A charged off loan with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outstanding balance of zero and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service credit will be reported as Account Status=97."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebtNoLoss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when a lender settles outstanding balance with a borrower as part of collection efforts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read carefully the difference between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebtNoLoss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" descriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT considered as \"loss\" in Metro2 logic of \"Account Status\" Base Segment field. A charged off loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with outstanding balance of zero and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebtNoLoss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service credit (assuming no service credits of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementOfDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"badDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceased"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exist) will be reported as Account Status=64."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when a lender confirms that a loan is fraudulent and wants to bring the loan balance to zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is considered as \"loss\" in Metro2 logic of \"Account Status\" Base Segment field."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"badDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used after a loan is charged off and the lender wants to write off the balance and make the loan balance zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is considered as \"loss\" in Metro2 logic of \"Account Status\" Base Segment field."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceased"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - can be used when a lender confirms a deceased case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is considered as \"loss\" in Metro2 logic of \"Account Status\" Base Segment field."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - should only be used when a bankruptcy case is discharged and the lender wants to bring the loan balance to zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is NOT reported to credit bureaus in Metro2 as \"Actual Payment Amount\" and \"Date of Last Payment\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This type of credit is used in the Metro2 logic of \"Account Status\" Base Segment field to report Account Status=64."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rounding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this type of service credit can be created by the Peach system only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this type of service credit can be created by the Peach system only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this type of service credit can be created by the Peach system only."},"children":[]}]}]}]}]}],"enum":["serviceAgent","serviceSupervisor","settlementOfDebt","settlementOfDebtNoLoss","balanceTransfer","rewards","fraud","badDebt","bankruptcy","deceased","usuryCap","refund","interestAdjustment","rounding"],"type":"string"}},"components/schemas/NormalTransaction":{"id":"components/schemas/NormalTransaction","kind":"json-schema","title":"NormalTransaction","data":{"allOf":[{"$ref":"#/components/schemas/BaseTransaction"},{"properties":{"chargebackAmount":{"description":"The total amount of all Open and Closed chargebacks on this transaction.\n","format":"float","nullable":true,"readOnly":true,"type":"number"},"chargebackDetails":{"items":{"$ref":"#/components/schemas/Chargeback"},"readOnly":true,"type":"array"},"effectiveAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The net/effective amount of the transaction after taking into account chargebacks, reversals, and disputes. The amount is calculated as:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount = actualAmount - reversedAmount - chargebackAmount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is calculated by Peach and cannot be set or updated via API."},"children":[]}]}]}],"format":"float","readOnly":true,"type":"number"},"isExternal":{"type":"boolean"},"isVirtual":{"type":"boolean"},"paidFeesAmount":{"format":"float","type":"number"},"paidInterestAmount":{"format":"float","type":"number"},"paidOverAmount":{"format":"float","type":"number"},"paidPrincipalAmount":{"format":"float","type":"number"},"serviceCreditDetails":{"description":"Information about credit.","properties":{"reason":{"description":"The reason why the payment was created.","enum":["oneTimePayment","reversal"],"type":"string"},"sponsor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sponsor of the credit. Mainly used for ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOwner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as expense in ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanServicer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as liability from the servicer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as liability from the merchant."},"children":[]}]}]}],"enum":["loanOwner","loanServicer","merchant"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/serviceCreditTypes"},{"description":"Type of the credit. Credit types are recorded differently in ledger/accounting."}]}},"type":"object"}},"type":"object"}]}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"allOf":[{"$ref":"#/components/schemas/NormalTransaction"},{"properties":{"autopayPaymentIds":{"description":"Peach identifiers of the autopay expected payments.","items":{"type":"integer"},"type":"array"},"autopayPlanId":{"description":"Peach identifier of the autopay plan.","type":"string"},"consentDocumentId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"writeOnly":false},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID of a one-time payment consent given by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower to debit their payment instrument.  The document is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored in the HTML format and contains the disclosure shown to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the borrower at the time of the payment.  Required if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Peach is processing payments (aka"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on behalf of the lender."},"children":[]}]}]}]}]},"drawId":{"description":"The draw identifier for the transaction.\n","type":"string"},"enablePrepayments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply any overpayment amount to prepayment of future obligations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply overpayments to the current obligation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not passed, we reference the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPrepayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration on the loan type."},"children":[]}]}]}],"type":"boolean"},"evidenceDocumentId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"writeOnly":false},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID of a one-time payment consent screenshot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"captured when a borrower made the payment.  Only applicable when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach App is used and company's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.evidence.captureScreenshot=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"initiatingBorrowerId":{"description":"The ID of the borrower who initiated the transaction.\n","nullable":true,"type":"string"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for record purposes only. A transaction with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically marked external."},"children":[]}]}]}]},"isVirtual":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isVirtual=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a real transaction, but represents a part of another transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to store the principal/interest split on draws in Line of Credits as well as splits between multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installment loans that were applied as a single payment."},"children":[]}]}]}]},"loanId":{"description":"The unique identifier of the Loan.\n","type":"string"},"mainBorrowerId":{"description":"The Peach identifier for the main borrower on the loan.\n","type":"string"},"paidFeesAmount":{"description":"The paid rounded amount allocated to fees\n"},"paidInterestAmount":{"description":"The paid rounded amount allocated to interest\n"},"paidOverAmount":{"description":"Stores any excess rounded amount that was not allocated to principal, interest or fees.\n"},"paidPrincipalAmount":{"description":"The paid rounded amount allocated to principal\n"},"unroundedPaidFeesAmount":{"description":"The paid unrounded amount allocated to fees\n","format":"float","type":"number"},"unroundedPaidInterestAmount":{"description":"The paid unrounded amount allocated to interest\n","format":"float","type":"number"},"unroundedPaidOverAmount":{"description":"Stores any excess unrounded amount that was not allocated to principal, interest or fees.\n","format":"float","type":"number"},"unroundedPaidPrincipalAmount":{"description":"The paid unrounded amount allocated to principal\n","format":"float","type":"number"}},"type":"object"}]}},"components/schemas/ContextVarLoanDataSource":{"id":"components/schemas/ContextVarLoanDataSource","kind":"json-schema","title":"ContextVarLoanDataSource","data":{"allOf":[{"$ref":"#/components/schemas/Loan"},{"properties":{"autopayData":{"description":"Autopay payment information. (Schema TBD)","type":"object"},"balances":{"$ref":"#/components/schemas/Balances"},"creditReporting":{"description":"Credit reporting data","properties":{"creditAgencies":{"items":{"properties":{"agencyName":{"description":"Name of the credit agency","type":"string"},"reportingStartDate":{"description":"Date the loan started reporting to the agency","format":"date","type":"string"}},"type":"object"},"type":"array"},"isReporting":{"type":"boolean"}},"type":"object"},"daysOverdue":{"description":"Number of days the loan is overdue","type":"integer"},"daysToChargeOff":{"description":"Number of days to charge off the loan","type":"integer"},"futureBalances":{"$ref":"#/components/schemas/FutureBalances"},"investors":{"description":"List of loan investors. (Schema TBD)","items":{"type":"object"},"type":"array"},"loanType":{"$ref":"#/components/schemas/LoanType"},"overdueAmount":{"description":"Amount overdue","type":"integer"},"overdueSummary":{"description":"Summary of overdue information","properties":{"daysOverdue":{"description":"Number of days the loan is overdue","type":"integer"},"isOverdue":{"description":"Is the loan overdue","type":"boolean"},"overdueAmount":{"description":"Amount overdue","type":"integer"}},"type":"object"},"people":{"description":"List of people associated with the loa","items":{"$ref":"#/components/schemas/Borrower"},"type":"array"},"transactions":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"}},"type":"object"}]}},"components/schemas/ContextVarPaymentAmount":{"id":"components/schemas/ContextVarPaymentAmount","kind":"json-schema","title":"ContextVarPaymentAmount","data":{"description":"The amount of the payment","multipleOf":0.01,"type":"number"}},"components/schemas/ContextVarPaymentDueDate":{"id":"components/schemas/ContextVarPaymentDueDate","kind":"json-schema","title":"ContextVarPaymentDueDate","data":{"description":"The due date of the payment","format":"date","type":"string"}},"components/schemas/ContextVarPaymentMethod":{"id":"components/schemas/ContextVarPaymentMethod","kind":"json-schema","title":"ContextVarPaymentMethod","data":{"description":"The payment method","enum":["bankAccount","card","check","payroll","paymentNetwork","moneyOrder","wire"],"type":"string"}},"components/schemas/ContextVarPaymentMethodLastFour":{"id":"components/schemas/ContextVarPaymentMethodLastFour","kind":"json-schema","title":"ContextVarPaymentMethodLastFour","data":{"description":"The last four digits of the payment method","type":"string"}},"components/schemas/ContextVarPerson":{"id":"components/schemas/ContextVarPerson","kind":"json-schema","title":"ContextVarPerson","data":{"allOf":[{"$ref":"#/components/schemas/Borrower"},{"properties":{"address":{"$ref":"#/components/schemas/Address"}},"type":"object"}]}},"components/schemas/AvailableTemplateContextSubjectAutopayAmountChanged":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayAmountChanged","kind":"json-schema","title":"autopayAmountChanged","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Autopay amount increased more then X%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 9am PST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayAmountChanged"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"extraCharge":{"description":"The additional charge above the original autopay amount.\n","type":"number"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentAmount":{"$ref":"#/components/schemas/ContextVarPaymentAmount"},"paymentDueDate":{"$ref":"#/components/schemas/ContextVarPaymentDueDate"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayAmountChanged","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AutopayCancelReason":{"id":"components/schemas/AutopayCancelReason","kind":"json-schema","title":"AutopayCancelReason","data":{"description":"Why the autopay was canceled.","enum":["invalidPaymentMethod","paymentMethodRemoved","tooManyFailedAttempts","loanFrozen","loanAccelerated","loanChargedOff","loanPaidOff","canceledByUser","loanTermsChanged"],"nullable":true,"type":"string"}},"components/schemas/AvailableTemplateContextSubjectAutopayCanceledBySystem":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayCanceledBySystem","kind":"json-schema","title":"autopayCanceledBySystem","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Autopay was canceled by the system because payment instrument became invalid or loan terms changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"},"reason":{"$ref":"#/components/schemas/AutopayCancelReason"}},"title":"autopayCanceledBySystem","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/ContextVarPaymentSchedule":{"id":"components/schemas/ContextVarPaymentSchedule","kind":"json-schema","title":"ContextVarPaymentSchedule","data":{"description":"The dates and amounts of payments to be made","items":{"properties":{"amount":{"type":"number"},"date":{"format":"date","type":"string"}},"type":"object"},"type":"array"}},"components/schemas/AvailableTemplateContextSubjectAutopayEnabled":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayEnabled","kind":"json-schema","title":"autopayEnabled","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Borrower or agent turned on Autopay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnabled"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"paymentSchedule":{"$ref":"#/components/schemas/ContextVarPaymentSchedule"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayEnabled","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectAutopayEnableReminder":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayEnableReminder","kind":"json-schema","title":"autopayEnableReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Borrower has not enabled autopay X days before the due date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 9am PST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnableReminder"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"nextDueDate":{"description":"The due date of the next payment.","format":"date","type":"string"},"paymentDays":{"description":"The number of days to the due date.","type":"integer"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayEnableReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectAutopayPaymentCanceled":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayPaymentCanceled","kind":"json-schema","title":"autopayPaymentCanceled","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Autopay scheduled payment was canceled (eg: due to low balance per Plaid check)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 1-2am Product Timezone"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentCanceled"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentAmount":{"$ref":"#/components/schemas/ContextVarPaymentAmount"},"paymentDate":{"$ref":"#/components/schemas/ContextVarPaymentDueDate"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayPaymentCanceled","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectAutopayPaymentMethodUpdated":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayPaymentMethodUpdated","kind":"json-schema","title":"autopayPaymentMethodUpdated","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Borrower or agent updated payment method on an existing Autopay plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentMethodUpdated"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"paymentSchedule":{"$ref":"#/components/schemas/ContextVarPaymentSchedule"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayPaymentMethodUpdated","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/ContextVarExpectedPaymentIds":{"id":"components/schemas/ContextVarExpectedPaymentIds","kind":"json-schema","title":"ContextVarExpectedPaymentIds","data":{"description":"The IDs of the expected payments objects representing payments not yet made.","items":{"example":"XP-L9BN-5J52","type":"string"},"type":"array"}},"components/schemas/ContextVarOverdueAmount":{"id":"components/schemas/ContextVarOverdueAmount","kind":"json-schema","title":"ContextVarOverdueAmount","data":{"description":"The overdue amount","multipleOf":0.01,"type":"number"}},"components/schemas/AvailableTemplateContextSubjectAutopayPaymentReminder":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayPaymentReminder","kind":"json-schema","title":"autopayPaymentReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Autopay payment reminder sent X days before the Autopay date, sent when autopay is on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 9am PST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentReminder"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"expectedPaymentIds":{"$ref":"#/components/schemas/ContextVarExpectedPaymentIds"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"overdueAmount":{"$ref":"#/components/schemas/ContextVarOverdueAmount"},"paymentAmount":{"$ref":"#/components/schemas/ContextVarPaymentAmount"},"paymentDate":{"$ref":"#/components/schemas/ContextVarPaymentDueDate"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayPaymentReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/ContextVarNewPaymentDate":{"id":"components/schemas/ContextVarNewPaymentDate","kind":"json-schema","title":"ContextVarNewPaymentDate","data":{"description":"The new payment date","format":"date","type":"string"}},"components/schemas/ContextVarOldPaymentDate":{"id":"components/schemas/ContextVarOldPaymentDate","kind":"json-schema","title":"ContextVarOldPaymentDate","data":{"description":"The old payment date","format":"date","type":"string"}},"components/schemas/AvailableTemplateContextSubjectAutopayPaymentRescheduled":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayPaymentRescheduled","kind":"json-schema","title":"autopayPaymentRescheduled","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Autopay scheduled payment was rescheduled (eg: due to low balance per Plaid check)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 1-2am Product Timezone"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentRescheduled"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"newPaymentDate":{"$ref":"#/components/schemas/ContextVarNewPaymentDate"},"oldPaymentDate":{"$ref":"#/components/schemas/ContextVarOldPaymentDate"},"paymentAmount":{"$ref":"#/components/schemas/ContextVarPaymentAmount"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayPaymentRescheduled","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectCardExpiresReminder":{"id":"components/schemas/AvailableTemplateContextSubjectCardExpiresReminder","kind":"json-schema","title":"cardExpiresReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Card payment method is expiring soon."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 9am PST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardExpiresReminder"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"month":{"description":"The full name of the month the card expires (e.g., October, not Oct).","type":"string"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"},"year":{"description":"The year the card expires.","type":"integer"}},"title":"cardExpiresReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/ContextVarCase":{"id":"components/schemas/ContextVarCase","kind":"json-schema","title":"ContextVarCase","data":{"allOf":[{"$ref":"#/components/schemas/Case"},{"properties":{"associatedLoanIds":{"description":"The IDs of the loans associated with this case.\n","type":"string"},"associatedLoans":{"description":"The loans associated with this case.\n","items":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"type":"array"},"isReportingAssociatedLoans":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any of the associated loans are reporting to credit agencies ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReporting=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/AvailableTemplateContextSubjectCeaseCommunicationAcknowledgement":{"id":"components/schemas/AvailableTemplateContextSubjectCeaseCommunicationAcknowledgement","kind":"json-schema","title":"ceaseCommunicationAcknowledgement","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Cease Communications Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ceaseCommunicationAcknowledgement"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"ceaseCommunicationAcknowledgement","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectCeaseRefuseToPay":{"id":"components/schemas/AvailableTemplateContextSubjectCeaseRefuseToPay","kind":"json-schema","title":"ceaseCommunicationRefuseToPay","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Cease Communications Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ceaseCommunicationRefuseToPay"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"ceaseCommunicationRefuseToPay","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectConfirmationCode":{"id":"components/schemas/AvailableTemplateContextSubjectConfirmationCode","kind":"json-schema","title":"confirmationCode","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (One time verification code sent to verify email or phone ownership.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmationCode"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"confirmationCode":{"description":"The confirmation code to be sent.","maxLength":6,"minLength":6,"type":"string"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"confirmationCode","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectContactTakeover":{"id":"components/schemas/AvailableTemplateContextSubjectContactTakeover","kind":"json-schema","title":"contactTakeover","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Another borrower \"claimed\" email or phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactTakeover"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"contactType":{"description":"The type of contact that was taken over. Only email and phone\ncan be taken over.\n","enum":["email","phone"],"type":"string"},"emailMasked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the phone number which was taken over,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with most of the characters replaced with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"person":{"$ref":"#/components/schemas/ContextVarPerson"},"phoneNumberLastFour":{"description":"The last four digits of the phone number which was taken over.","maxLength":4,"minLength":4,"type":"string"}},"title":"contactTakeover","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectCustomX":{"id":"components/schemas/AvailableTemplateContextSubjectCustomX","kind":"json-schema","title":"customX","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM, once configured.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"customX","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDebtValidationNotice":{"id":"components/schemas/AvailableTemplateContextSubjectDebtValidationNotice","kind":"json-schema","title":"debtValidationNotice","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM when a new loan is created.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidationNotice"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"debtValidationNotice","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeArizona":{"id":"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeArizona","kind":"json-schema","title":"debtValidationNoticeArizona","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Can be configured on loan type to be sent upon loanActivation or loanFirstOverdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidationNoticeArizona"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"debtValidationNoticeArizona","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeAutomatic":{"id":"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeAutomatic","kind":"json-schema","title":"debtValidationNoticeAutomatic","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Can be configured on loan type to be sent upon loanActivation or loanFirstOverdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidationNoticeAutomatic"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"debtValidationNoticeAutomatic","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeNYCYonkers":{"id":"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeNYCYonkers","kind":"json-schema","title":"debtValidationNoticeNYCYonkers","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM when a new loan is created.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidationNoticeNYCYonkers"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"debtValidationNoticeNYCYonkers","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticePuertoRico":{"id":"components/schemas/AvailableTemplateContextSubjectDebtValidationNoticePuertoRico","kind":"json-schema","title":"debtValidationNoticePuertoRico","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Can be configured on loan type to be sent upon loanActivation or loanFirstOverdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debtValidationNoticePuertoRico"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"debtValidationNoticePuertoRico","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDeceasedConfirmationOfPayoff":{"id":"components/schemas/AvailableTemplateContextSubjectDeceasedConfirmationOfPayoff","kind":"json-schema","title":"deceasedConfirmationOfPayoff","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Deceased Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceasedConfirmationOfPayoff"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"deceasedConfirmationOfPayoff","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDeceasedNoticeToRepresentative":{"id":"components/schemas/AvailableTemplateContextSubjectDeceasedNoticeToRepresentative","kind":"json-schema","title":"deceasedNoticeToRepresentative","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Deceased Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceasedNoticeToRepresentative"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"deceasedNoticeToRepresentative","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDeceasedNotificationUponDeath":{"id":"components/schemas/AvailableTemplateContextSubjectDeceasedNotificationUponDeath","kind":"json-schema","title":"deceasedNotificationUponDeath","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Deceased Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deceasedNotificationUponDeath"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"deceasedNotificationUponDeath","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentation":{"id":"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentation","kind":"json-schema","title":"disputeOfDebtSubmitDocumentation","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Dispute Of Debt Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebtSubmitDocumentation"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"disputeOfDebtSubmitDocumentation","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtConfirmed":{"id":"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtConfirmed","kind":"json-schema","title":"disputeOfDebtConfirmed","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Dispute Of Debt Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebtConfirmed"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"disputeOfDebtConfirmed","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentationReminder":{"id":"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentationReminder","kind":"json-schema","title":"disputeOfDebtSubmitDocumentationReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Dispute Of Debt Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebtSubmitDocumentationReminder"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"disputeOfDebtSubmitDocumentationReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToConfirm":{"id":"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToConfirm","kind":"json-schema","title":"disputeOfDebtUnableToConfirm","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Dispute Of Debt Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebtUnableToConfirm"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"disputeOfDebtUnableToConfirm","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToResolve":{"id":"components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToResolve","kind":"json-schema","title":"disputeOfDebtUnableToResolve","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM with an associated Dispute Of Debt Case.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disputeOfDebtUnableToResolve"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"disputeOfDebtUnableToResolve","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectElectronicConsentOptOut":{"id":"components/schemas/AvailableTemplateContextSubjectElectronicConsentOptOut","kind":"json-schema","title":"electronicConsentOptOut","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: System (Agent revoked consent to electronic communication per borrower request.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electronicConsentOptOut"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"electronicConsentOptOut","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectFailedSettlementInvestor":{"id":"components/schemas/AvailableTemplateContextSubjectFailedSettlementInvestor","kind":"json-schema","title":"failedSettlementInvestor","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: System (Settlement of funds failed.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failedSettlementInvestor"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"companyName":{"description":"The name of the company.","type":"string"},"investorContactName":{"description":"The name of the investor.","type":"string"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"failedSettlementInvestor","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectFreeFormBranded":{"id":"components/schemas/AvailableTemplateContextSubjectFreeFormBranded","kind":"json-schema","title":"freeFormBranded","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeFormBranded"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"freeFormBranded","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectFuturepayCanceled":{"id":"components/schemas/AvailableTemplateContextSubjectFuturepayCanceled","kind":"json-schema","title":"futurepayCanceledf","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"futurepayCanceled"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"futurepayCanceledf","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectFuturepayPaymentDueReminder":{"id":"components/schemas/AvailableTemplateContextSubjectFuturepayPaymentDueReminder","kind":"json-schema","title":"futurepayPaymentDueReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: 9am PST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"futurepayPaymentDueReminder"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"futurepayPaymentDueReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftIncompleteDocumentation":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftIncompleteDocumentation","kind":"json-schema","title":"identityTheftIncompleteDocumentation","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftIncompleteDocumentation"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftIncompleteDocumentation","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationFirstReminder":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationFirstReminder","kind":"json-schema","title":"identityTheftSubmitDocumentationFirstReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftSubmitDocumentationFirstReminder"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftSubmitDocumentationFirstReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentation":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentation","kind":"json-schema","title":"identityTheftSubmitDocumentation","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftSubmitDocumentation"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftSubmitDocumentation","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationSecondReminder":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationSecondReminder","kind":"json-schema","title":"identityTheftSubmitDocumentationSecondReminder","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftSubmitDocumentationSecondReminder"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftSubmitDocumentationSecondReminder","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftValidated":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftValidated","kind":"json-schema","title":"identityTheftValidated","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftValidated"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftValidated","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectIdentityTheftNotValidated":{"id":"components/schemas/AvailableTemplateContextSubjectIdentityTheftNotValidated","kind":"json-schema","title":"identityTheftNotValidated","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent When"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger: Manual (Agent can send via CRM associated with Identity Theft Case Type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When: Immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityTheftNotValidated"},"children":[]}]}]}],"properties":{"case":{"$ref":"#/components/schemas/ContextVarCase"},"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"identityTheftNotValidated","type":"object","x-tags":["System Sent Messages"]}},"components/schemas/AvailableTemplateContextSubjectAutopayAgreement":{"id":"components/schemas/AvailableTemplateContextSubjectAutopayAgreement","kind":"json-schema","title":"autopayAgreement","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed When"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autopay agreement shown to a borrower when they turn on Autopay."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it displays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayAgreement"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"loan":{"$ref":"#/components/schemas/ContextVarLoanDataSource"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"autopayAgreement","type":"object","x-tags":["System Documents & UI"]}},"components/schemas/AvailableTemplateContextSubjectDrawFundsDisclosure":{"id":"components/schemas/AvailableTemplateContextSubjectDrawFundsDisclosure","kind":"json-schema","title":"drawFundsDisclosure","data":{"description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed When"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dislosure/consent shown to a borrower when they request to draw additional funds on line of credit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables included by system when it displays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFundsDisclosure"},"children":[]}]}]}],"properties":{"company":{"$ref":"#/components/schemas/Company"},"drawAmount":{"description":"The amount of additional funds drawn.\n","type":"number"},"institutionName":{"description":"The name of the institution from which the funds are drawn.\n","type":"string"},"paymentMethod":{"$ref":"#/components/schemas/ContextVarPaymentMethod"},"paymentMethodLastFour":{"$ref":"#/components/schemas/ContextVarPaymentMethodLastFour"},"person":{"$ref":"#/components/schemas/ContextVarPerson"}},"title":"drawFundsDisclosure","type":"object","x-tags":["System Documents & UI"]}},"components/schemas/ContextObject":{"id":"components/schemas/ContextObject","kind":"json-schema","title":"ContextObject","data":{"anyOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data used to render the template. Provided in JSON format, it must be a mapping"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of context variables to values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"do not need to be provided since the system will automatically add these objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to context assuming you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example if your provided the context..."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"dateSigned\": \"Aug 27, 2021\"\n  \"lenderName\": \"Peachy Lender\"\n  \"paymentMethod\": \"bankAccount\"\n  \"paymentMethodLastFour\": \"1110\"\n  \"supportEmail\": \"support@peach.com\"\n  \"supportPhone\": \"888-888-8888\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"dateSigned\": \"Aug 27, 2021\"\n  \"lenderName\": \"Peachy Lender\"\n  \"paymentMethod\": \"bankAccount\"\n  \"paymentMethodLastFour\": \"1110\"\n  \"supportEmail\": \"support@peach.com\"\n  \"supportPhone\": \"888-888-8888\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"...then a template like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Hello from {{lenderName}}!"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would render like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Hello from Peachy Lender!"},"children":[]}]}]}],"type":"object"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayAmountChanged"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayCanceledBySystem"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayEnabled"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayEnableReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentCanceled"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentMethodUpdated"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayPaymentRescheduled"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectCardExpiresReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectCeaseCommunicationAcknowledgement"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectCeaseRefuseToPay"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectConfirmationCode"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectContactTakeover"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectCustomX"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNotice"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeArizona"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeAutomatic"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticeNYCYonkers"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDebtValidationNoticePuertoRico"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDeceasedConfirmationOfPayoff"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDeceasedNoticeToRepresentative"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDeceasedNotificationUponDeath"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentation"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtConfirmed"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtSubmitDocumentationReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToConfirm"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDisputeOfDebtUnableToResolve"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectElectronicConsentOptOut"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectFailedSettlementInvestor"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectFreeFormBranded"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectFuturepayCanceled"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectFuturepayPaymentDueReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftIncompleteDocumentation"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationFirstReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentation"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftSubmitDocumentationSecondReminder"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftValidated"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectIdentityTheftNotValidated"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectAutopayAgreement"},{"$ref":"#/components/schemas/AvailableTemplateContextSubjectDrawFundsDisclosure"}],"x-peach-hacks":"remove-available-template-context-subjects"}},"components/schemas/TemplateRender":{"id":"components/schemas/TemplateRender","kind":"json-schema","title":"TemplateRender","data":{"properties":{"caseId":{"description":"The unique identifier of the Case. Can be Peach or lender's external identifier. The case attributes will be used as dynamic fields in the template.\n","type":"string"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates with the same subject can have multiple versions per channel. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFailed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message (aka SMS) versions."},"children":[]}]}]}],"enum":["email","text","mail","gui","document"],"type":"string"},"context":{"$ref":"#/components/schemas/ContextObject"},"loanId":{"description":"The unique identifier of the Loan. Can be Peach or lender's external identifier. The loan attributes will be used as dynamic fields in the template.\n","type":"string"},"overrideTemplateId":{"$ref":"#/components/schemas/OverrideTemplateId"},"personId":{"description":"The unique identifier of the Borrower. Can be Peach or a lender's external identifier. The borrower attributes will be used as dynamic fields in the template.\n","type":"string"},"subject":{"$ref":"#/components/schemas/InteractionSubject"}},"type":"object"}},"components/schemas/SendMessageChannel":{"id":"components/schemas/SendMessageChannel","kind":"json-schema","title":"SendMessageChannel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channels the Send Message endpoint can deliver to. This is a subset of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InteractionChannel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gui"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not valid send channels and requests using them are rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["voice","email","text","mail"],"type":"string"}},"components/schemas/SendIsTransactional":{"id":"components/schemas/SendIsTransactional","kind":"json-schema","title":"SendIsTransactional","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then sent this interaction as \"transactional\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactional interactions are those which are sent via an automated system in response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to an event or some action taken. e.g., an email sent to confirm a payment was made is transactional;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"likewise an email sent to confirm a password change is transacrtional. Examples of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-transactional messages would be: those sent by an agent in response to a customer request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for collections, or for marketing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's important to mark these messages correctly, because different laws may apply to messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depending on if they're considered \"transactional\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, a transactional interaction may be sent with different \"From:\" and \"Reply-To:\" fields depending on configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purpose here being that it may be desirable to send messages from an email address"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is clearly marked as \"unmonitored\", so that recipients do not try to respond"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"directly to those email addresses."},"children":[]}]}]}],"type":"boolean"}},"components/schemas/SendIsTransactionalDefaultTrue":{"id":"components/schemas/SendIsTransactionalDefaultTrue","kind":"json-schema","title":"SendIsTransactionalDefaultTrue","data":{"allOf":[{"$ref":"#/components/schemas/SendIsTransactional"},{"default":true,"type":"boolean"}]}},"components/schemas/schemas-AssociatedLoanId":{"id":"components/schemas/schemas-AssociatedLoanId","kind":"json-schema","title":"schemas-AssociatedLoanId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a Loan. This marks a particular loan as associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hydrates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" context variable for use in the template"},"children":[]}]}]}],"example":"LN-AAAA-BBBB","type":"string"}},"components/schemas/schemas-AssociatedLoanIds":{"id":"components/schemas/schemas-AssociatedLoanIds","kind":"json-schema","title":"schemas-AssociatedLoanIds","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of several loans. This marks several loans as associated with this interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hydrates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" context variable for use in the template"},"children":[]}]}]}],"example":["LN-AAAA-BBBB","LB-CCCC-DDDD"],"items":{"type":"string"},"type":"array"}},"components/schemas/CommunicatorSend":{"id":"components/schemas/CommunicatorSend","kind":"json-schema","title":"CommunicatorSend","data":{"properties":{"attachments":{"description":"List of document IDs for documents to attach to the outgoing email.\n","items":{"description":"A document descriptor ID.","type":"string"},"type":"array"},"caseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark a particular case as associated with this message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hydates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" context variable for use in the template"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being rendered for send."},"children":[]}]}]}],"example":"CS-AAAA-BBBB","type":"string"},"channel":{"description":"Specifies the channel(s) to send the message on.\n\nIf an array is provided then the message will be sent to the most appropriate contact\nfor each specified channel. As long as at least one contact is found, the message\nwill be sent, if at least one contact could be found then an error will be returned.\n","oneOf":[{"$ref":"#/components/schemas/SendMessageChannel"},{"items":{"$ref":"#/components/schemas/SendMessageChannel"},"type":"array"}]},"contactId":{"description":"The Contact ID of the borrower to which this message should be sent.\n\nIf not provided then the system will try to select an appropriate\ncontact based on the type of message being sent. (e.g., if this\nis an email select the primary email address; if this is a\ntext message select the borrower's mobile phone.)\n","example":"BO-AAAA-BBBB","type":"string"},"context":{"$ref":"#/components/schemas/ContextObject"},"interactionExternalId":{"description":"The external ID of the interaction that will be created as a\nresult of this request. Subsequent attempts to send with the\nsame external ID will be blocked.\n","maxLength":50,"type":"string"},"isTransactional":{"$ref":"#/components/schemas/SendIsTransactionalDefaultTrue"},"loanId":{"$ref":"#/components/schemas/schemas-AssociatedLoanId"},"loanIds":{"$ref":"#/components/schemas/schemas-AssociatedLoanIds"},"overrideRecipient":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient to which this message should be sent. This should be used in special"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cases where you cannot create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING: It is not recommended to use this field. Instead use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this field if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interaction channel is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousInteractionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, to an email interaction belonging to that borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That previous interaction was sent \"from:\" the same email address as the one you want to send to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only email addresses are supported for this field."},"children":[]}]}]}]}],"minLength":1,"nullable":true,"type":"string"},"overrideTemplateId":{"$ref":"#/components/schemas/OverrideTemplateId"},"personId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Borrower ID of the borrower to which this message should be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hydates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" context variable for use in the template"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being rendered for send."},"children":[]}]}]}],"example":"BO-AAAA-BBBB","type":"string"},"previousInteractionId":{"type":"string"},"sendAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute determines when the message should be sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the message's timing conflicts with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Guard's time-of-day restrictions, Communicator"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will automatically reschedule it to an allowable time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this auto-rescheduling occurs, the sendAt field in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interaction response will show the new scheduled time, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Interaction status will be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To bypass auto-rescheduling, input the current time for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when calling the endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Information:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regardless of when the message is scheduled to send, its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content will be generated immediately upon calling this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can manually set a future send time of up to 7 days in the future."},"children":[]}]}]}]}],"format":"date-time","type":"string"},"sendJitter":{"description":"The maximum number of seconds to add to the send time for this communication.\nThe actual time added will be between 0 and this value.\nThis is useful for spreading out the delivery\nof a large batch of messages over a period of time in order\nto avoid delaying other time-sensitive communcations.\n","format":"int32","type":"integer"},"statementId":{"description":"Mark a particular statement as associated with this message.","example":"SM-AAAA-BBBB","type":"string"},"strictUndefined":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an error will be returned if the template contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a variable that is not defined in the context. For historical"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasons this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default, but it is recommended"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"subject":{"$ref":"#/components/schemas/InteractionSubject"},"supercaseBulkOperationId":{"type":"string"},"theme":{"$ref":"#/components/schemas/InteractionTheme"},"useTemplate":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel=mail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will not generate content from a template and will instead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only use the documents referenced in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"}},"required":["subject","personId"],"type":"object"}},"components/schemas/SendIsTransactionalDefaultFalse":{"id":"components/schemas/SendIsTransactionalDefaultFalse","kind":"json-schema","title":"SendIsTransactionalDefaultFalse","data":{"allOf":[{"$ref":"#/components/schemas/SendIsTransactional"},{"default":false,"type":"boolean"}]}},"components/schemas/language":{"id":"components/schemas/language","kind":"json-schema","title":"language","data":{"default":"en","description":"The ISO 639-1 two character code of the email language.","example":"en","maxLength":2,"minLength":2,"type":"string"}},"components/schemas/SubjectDescriptor":{"id":"components/schemas/SubjectDescriptor","kind":"json-schema","title":"SubjectDescriptor","data":{"properties":{"agentCanSend":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", agent can send message with this subject from CRM."},"children":[]}]}]}],"type":"boolean"},"caseTypes":{"items":{"$ref":"#/components/schemas/BaseCaseType"},"type":"array"},"previewOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the output of templates with this subject must be edited before sending."},"children":[]}]}]}],"type":"boolean"},"subject":{"allOf":[{"readOnly":true},{"$ref":"#/components/schemas/InteractionSubject"}]},"theme":{"$ref":"#/components/schemas/InteractionTheme"},"title":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"** DEPRECATED ATTRIBUTE **"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title to use when showing in the UI."},"children":[]}]}]}],"readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/CompanyId":{"id":"components/schemas/CompanyId","kind":"json-schema","title":"CompanyId","data":{"example":"CP-AAAA-BBBB","pattern":"CP-[A-Z0-9]{4}-[A-Z0-9]{4}","type":"string"}},"components/schemas/TemplateVersionId":{"id":"components/schemas/TemplateVersionId","kind":"json-schema","title":"TemplateVersionId","data":{"example":"TV-AAAA-BBBB","pattern":"TV-[A-Z0-9]{4}-[A-Z0-9]{4}","type":"string"}},"components/schemas/ActiveTemplateVersionId":{"id":"components/schemas/ActiveTemplateVersionId","kind":"json-schema","title":"ActiveTemplateVersionId","data":{"allOf":[{"$ref":"#/components/schemas/TemplateVersionId"},{"description":"The ID of the active version of the template. This is the version that will be used when rendering the template.\n","nullable":true,"type":"string"}]}},"components/schemas/TemplateDescriptorId":{"id":"components/schemas/TemplateDescriptorId","kind":"json-schema","title":"TemplateDescriptorId","data":{"description":"ID of the Template Descriptor","example":"TD-AAAA-BBBB","pattern":"TD-[A-Z0-9]{4}-[A-Z0-9]{4}","type":"string"}},"components/schemas/LoanTypeIdNullable":{"id":"components/schemas/LoanTypeIdNullable","kind":"json-schema","title":"LoanTypeIdNullable","data":{"description":"The Loan Type ID to which this template is associated. By configuring\na Loan Type for a Template Descriptor it is possible to use completely different \ntemplates for different types of loans.\n","example":"LT-AAAA-BBBB","nullable":true,"pattern":"LT-[A-Z0-9]{4}-[A-Z0-9]{4}","type":"string"}},"components/schemas/TemplateSubject":{"id":"components/schemas/TemplateSubject","kind":"json-schema","title":"TemplateSubject","data":{"anyOf":[{"$ref":"#/components/schemas/InteractionSubject"},{"enum":["base1","base2","base3"],"type":"string"}],"description":"The subject of the template","type":"string"}},"components/schemas/TemplateDescriptorMutate":{"id":"components/schemas/TemplateDescriptorMutate","kind":"json-schema","title":"TemplateDescriptorMutate","data":{"additionalProperties":false,"properties":{"channel":{"$ref":"#/components/schemas/InteractionChannel"},"enabled":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then this template is disabled. Attempts to send messages with this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"template will be rejected. (Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses from the API.)"},"children":[]}]}]}],"type":"boolean"},"language":{"$ref":"#/components/schemas/language"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional human-friendly name for templates. Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom100"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"family of subjects can have a custom name."},"children":[]}]}]}],"maximum":100,"minimum":1,"type":"string"},"productId":{"$ref":"#/components/schemas/LoanTypeIdNullable"},"sensitive":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then all interactions and documents created from this template will have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Such interaction and documents cannot have their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content viewed except with a special permission ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usually this would be used to prevent employees without need to access"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"private information from accessing it."},"children":[]}]}]}],"type":"boolean"},"subject":{"$ref":"#/components/schemas/TemplateSubject"}},"type":"object"}},"components/schemas/TemplateDescriptor":{"id":"components/schemas/TemplateDescriptor","kind":"json-schema","title":"TemplateDescriptor","data":{"allOf":[{"properties":{"activeVersionId":{"$ref":"#/components/schemas/ActiveTemplateVersionId","description":"The ID of the active version of the template. This is the version that will be used when rendering the template.\n","example":"TV-AAAA-BBBB"},"companyId":{"$ref":"#/components/schemas/CompanyId"},"id":{"$ref":"#/components/schemas/TemplateDescriptorId"}},"type":"object"},{"$ref":"#/components/schemas/TemplateDescriptorMutate"}]}},"components/schemas/ContentHtmlTemplate":{"id":"components/schemas/ContentHtmlTemplate","kind":"json-schema","title":"ContentHtmlTemplate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid Jinja template to use for the content HTML body. This is used, for instance,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the body of an HTML email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is simply ignored when the channel does not need HTML content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables available to this template are the same as the context available to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentTextTemplate"},"children":[]}]}]}],"example":"Hello,<br/><p>{{foobar}}</p>","nullable":true,"type":"string"}},"components/schemas/ContentTextTemplate":{"id":"components/schemas/ContentTextTemplate","kind":"json-schema","title":"ContentTextTemplate","data":{"description":"A valid Jinja template to use for the content text body. This is used, for instance,\nfor the body of a plain text email or text message.\n","example":"Hello {{foobar}}","nullable":true,"type":"string"}},"components/schemas/SubjectLineTemplate":{"id":"components/schemas/SubjectLineTemplate","kind":"json-schema","title":"SubjectLineTemplate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid Jinja template to use for the subject line. This is used, for instance,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the subject line when sending emails."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is simply ignored when the channel does not need a subject."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context variables available to this template are the same as the context available to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentTextTemplate"},"children":[]}]}]}],"example":"Hello {{foobar}}","nullable":true,"type":"string"}},"components/schemas/TemplateVersionMutate":{"id":"components/schemas/TemplateVersionMutate","kind":"json-schema","title":"TemplateVersionMutate","data":{"additionalProperties":false,"properties":{"activate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applies when creating a template version. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the newly created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version is immediately set as the active version of its template descriptor,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equivalent to calling the activate endpoint in a separate request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicator.template:activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicator.template:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is ignored on update."},"children":[]}]}]}],"type":"boolean"},"contentHtmlTemplate":{"$ref":"#/components/schemas/ContentHtmlTemplate"},"contentTextTemplate":{"$ref":"#/components/schemas/ContentTextTemplate"},"descriptorId":{"$ref":"#/components/schemas/TemplateDescriptorId"},"subjectLineTemplate":{"$ref":"#/components/schemas/SubjectLineTemplate"}}}},"components/schemas/TemplateVersion":{"id":"components/schemas/TemplateVersion","kind":"json-schema","title":"TemplateVersion","data":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/TemplateVersionId"}},"type":"object"},{"$ref":"#/components/schemas/TemplateVersionMutate"}]}},"components/schemas/OneTimeCodeChannel":{"id":"components/schemas/OneTimeCodeChannel","kind":"json-schema","title":"OneTimeCodeChannel","data":{"description":"The channel via which to send the one time code through.\n","enum":["email","text","voice"],"type":"string"}},"components/schemas/CollectionAgencyCreate":{"id":"components/schemas/CollectionAgencyCreate","kind":"json-schema","title":"CollectionAgencyCreate","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"contactEmail":{"description":"The third party debt collection agency email address that the charged-off loan was assigned to.\n","type":"string"},"contactPhone":{"description":"The third party debt collection agency primary phone that the charged-off loan was assigned to. Should be provided in E.164 format.\n","type":"string"},"legalName":{"description":"The third party debt collection agency name that the charged-off loan was assigned to.\n","type":"string"},"mailingAddress":{"$ref":"#/components/schemas/AddressBase","description":"The third party debt collection agency mailing address that the charged-off loan was assigned to.\n"}},"type":"object"}]}},"components/schemas/CollectionAgency":{"id":"components/schemas/CollectionAgency","kind":"json-schema","title":"CollectionAgency","data":{"allOf":[{"$ref":"#/components/schemas/CollectionAgencyCreate"},{"properties":{"isArchived":{"description":"Set to true if the debt collection agency no longer active. Loans that were assigned to that agency will keep the reference, but new loans cannot be assigned.\n","type":"boolean"}},"type":"object"}]}},"components/schemas/CollectionAgencyPost":{"id":"components/schemas/CollectionAgencyPost","kind":"json-schema","title":"CollectionAgencyPost","data":{"allOf":[{"$ref":"#/components/schemas/CollectionAgencyCreate"},{"properties":{"mailingAddress":{"allOf":[{"$ref":"#/components/schemas/AddressBase"},{"required":["addressLine1","city","state","postalCode","country"],"type":"object"}]}},"type":"object"}]}},"components/schemas/AgencyName":{"id":"components/schemas/AgencyName","kind":"json-schema","title":"AgencyName","data":{"description":"The credit agency name.\n","enum":["experian","equifax","transUnion","innovis"],"type":"string"}},"components/schemas/CreditAgency":{"id":"components/schemas/CreditAgency","kind":"json-schema","title":"CreditAgency","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"agencyName":{"$ref":"#/components/schemas/AgencyName"},"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"country":{"description":"The credit agency country.","maxLength":2,"type":"string"},"dataFormat":{"description":"The format of the reported data and file.","enum":["metro2"],"type":"string"},"encryptionMethod":{"description":"The encryption method that Peach system with use to encrypt the files.\n","enum":["GPG"],"nullable":true,"type":"string"},"fileNamePrefix":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file name prefix. Must be provided if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencyName=experian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nameFilePerAgencyConvention=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only used if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencyName=experian"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nameFilePerAgencyConvention=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"isPeachAggregator":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is deprecated, and is only included to remain backward compatible. Only send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"nameFilePerAgencyConvention":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Peach system will name the file based on the credit agency convention."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equifax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEACHFINANCEINCCPYL69X5Z1EQUIFAX20211021.txt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Experian"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileNamePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + today's date MMDDYYYY + .txt."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: MKFRT.10262021.txt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TransUnion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEACHFINANCEINCCPYL69X5Z1TRANSUNION20211213.txt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Peach system will name the file as:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEACHFINANCEINCCPYL69X5Z1EXPERIAN20211021.txt"},"children":[]}]}]}],"type":"boolean"},"publicKey":{"description":"The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.","nullable":true,"type":"string"},"sftpAccessMethod":{"default":"usernamePassword","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usernamePassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpUsername"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpPassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPrivateKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created by peach."},"children":[]}]}]}],"enum":["usernamePassword","keys"],"type":"string"},"sftpCdDir":{"description":"Change directory into this folder before performing the upload.\n","type":"string"},"sftpHostname":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SFTP hostname. If SFTP hostname, username, and password are set, they will be used instead of the default credit bureau credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host name should not contain a scheme, so don't put "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftp://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the front. You may optionally specify a port like so: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com:222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no port is supplied a default of 22 will be used."},"children":[]}]}]}],"nullable":true,"pattern":"^[^/]+$","type":"string"},"sftpPassword":{"description":"The password for SFTP.\n","nullable":true,"type":"string"},"sftpSSHPeachPrivateKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An opaque reference to Peach's SSH private key, used internally to authenticate with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpHostname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpAccessMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"readOnly":true,"type":"string"},"sftpSSHPeachPublicKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's SSH public key to be whitelisted on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpHostname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpAccessMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"readOnly":true,"type":"string"},"sftpUsername":{"description":"The username for SFTP.\n","nullable":true,"type":"string"},"specificDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific days designate the day(s) when to upload the credit reporting file. Only the 1st day of the month is currently supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allowed values for specific day(s) depends on the uploadFrequency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate the last day of a month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1]."},"children":[]}]}]}],"items":{"maximum":31,"minimum":1,"type":"integer"},"type":"array"},"uploadFrequency":{"description":"The credit reporting file creation frequency. Only monthly is currently supported.","enum":["monthly"],"type":"string"},"useLoanExternalId":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates what identifier to use as an account identifier for credit reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will use loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as an account identifier for credit reporting. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't exist the system will use loan Peach Public ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will use loan Peach Public ID (e.g. LN-JFU3-ER3S) as an account identifier for credit reporting."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"properties":{"message":{"nullable":true,"readOnly":true,"type":"string"},"status":{"format":"int32","readOnly":true,"type":"integer"}},"required":["status"],"type":"object"}},"components/schemas/CallSummaryResultStatus":{"id":"components/schemas/CallSummaryResultStatus","kind":"json-schema","title":"CallSummaryResultStatus","data":{"description":"The status of the call summary result.","enum":["pending","completed","failed"],"type":"string"}},"components/schemas/CallSummaryResult":{"id":"components/schemas/CallSummaryResult","kind":"json-schema","title":"CallSummaryResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"companyId":{"description":"The unique company identifier.","type":"string"},"object":{"default":"AICallSummaryResult","enum":["AICallSummaryResult"],"type":"string"},"status":{"$ref":"#/components/schemas/CallSummaryResultStatus"},"summary":{"description":"The summary of the call.","nullable":true,"type":"string"},"transcriptionResultId":{"description":"The unique identifier for the call transcription result.","type":"string"}},"type":"object"}],"description":"Represents the result of a call summary."}},"components/schemas/CallSummaryResultsPaging":{"id":"components/schemas/CallSummaryResultsPaging","kind":"json-schema","title":"CallSummaryResultsPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CallSummaryResult"},"type":"array"}},"type":"object"}]}},"components/schemas/InteractionsManyNoPaging":{"id":"components/schemas/InteractionsManyNoPaging","kind":"json-schema","title":"InteractionsManyNoPaging","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Interaction"},"type":"array"},"message":{"type":"string"},"status":{"description":"HTTP status code.","type":"integer"}},"type":"object"}},"components/schemas/InvestorImmutableFields":{"id":"components/schemas/InvestorImmutableFields","kind":"json-schema","title":"InvestorImmutableFields","data":{"properties":{"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency that the investor will receive settlements in. Use ISO currency codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all investors, other currencies are not supported yet."},"children":[]}]}]}],"readOnly":true,"type":"string"},"externalId":{"description":"A lender's identifier for the investor.","type":"string"},"id":{"description":"The investor ID","readOnly":true,"type":"string"},"legalName":{"description":"The legal name of the investor.","type":"string"}},"type":"object"}},"components/schemas/ValidAddress":{"id":"components/schemas/ValidAddress","kind":"json-schema","title":"ValidAddress","data":{"description":"Identifies the address as valid or invalid.","readOnly":true,"type":"boolean"}},"components/schemas/InvestorMutableFields":{"id":"components/schemas/InvestorMutableFields","kind":"json-schema","title":"InvestorMutableFields","data":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"contactEmail":{"description":"The email of the investor's primary contact person.","format":"email","type":"string"},"contactName":{"description":"The name of the investor's primary contact person.","type":"string"},"contactPhone":{"description":"The phone number of the investor's primary contact person.","maxLength":15,"type":"string"},"default":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark this investor as the default investor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At loan creation, if no investors are specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.investors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute, the investor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"added with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shares=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (100%)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a new investor is created and there is another investor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the other investor."},"children":[]}]}]}],"type":"boolean"},"validAddress":{"$ref":"#/components/schemas/ValidAddress"}},"type":"object"}},"components/schemas/Investor":{"id":"components/schemas/Investor","kind":"json-schema","title":"Investor","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/InvestorImmutableFields"},{"$ref":"#/components/schemas/InvestorMutableFields"}],"required":["legalName"],"title":"Investor"}},"components/schemas/InvestorMutable":{"id":"components/schemas/InvestorMutable","kind":"json-schema","title":"Investor","data":{"allOf":[{"$ref":"#/components/schemas/InvestorMutableFields"}],"title":"Investor"}},"components/schemas/PaymentInstrumentImmutableFields":{"id":"components/schemas/PaymentInstrumentImmutableFields","kind":"json-schema","title":"PaymentInstrumentImmutableFields","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"activeAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time at which the instrument was set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Unique identifier of the instrument.","readOnly":true,"type":"string"},"inactiveAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time at which the instrument was set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","readOnly":true,"type":"string"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment instrument marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not verified and creates transactions for record purposes only. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is required to set this flag."},"children":[]}]}]}],"type":"boolean"},"pendingAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time at which the instrument was set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","nullable":true,"type":"string"}},"type":"object"}]}},"components/schemas/TransactionFailureReason":{"id":"components/schemas/TransactionFailureReason","kind":"json-schema","title":"TransactionFailureReason","data":{"description":"The transaction failure reason.","enum":["insufficientFunds","chargeback","accountClosed","invalidAccount","unknownReason","invalidCvv","invalidExpirationDate","avsFailed","networkError","cardDeclined","accountFrozen","deceased","invalidRouting","paymentStopped","microdepositsFailed","microdepositsAttemptFailed","incorrectNumber","fraudulent","unauthorizedDebit"],"type":"string"}},"components/schemas/PaymentInstrumentFailureReasons":{"id":"components/schemas/PaymentInstrumentFailureReasons","kind":"json-schema","title":"PaymentInstrumentFailureReasons","data":{"properties":{"failureDescriptionLong":{"description":"Detailed text describing the failure reason and any appropriate actions the borrower may take to fix the issue.\nNormally displayed in UI.\n","readOnly":true,"type":"string"},"failureDescriptionShort":{"description":"Short text describing the failure reason. Normally displayed in UI.\n","readOnly":true,"type":"string"},"failureReason":{"$ref":"#/components/schemas/TransactionFailureReason","description":"A failure code for the most recent transaction failure using this instrument.\n","nullable":true}},"type":"object"}},"components/schemas/PaymentInstrumentMutableFields":{"id":"components/schemas/PaymentInstrumentMutableFields","kind":"json-schema","title":"PaymentInstrumentMutableFields","data":{"properties":{"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"minLength":1,"nullable":true,"type":"string"},"inactiveReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason the instrument is inactive. Required when setting status="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["fraudAlert","updated","notVerified","expired","failed","deleted"],"type":"string"},"nickname":{"description":"A nickname for the instrument. The nickname can be displayed in UI.","type":"string"},"status":{"default":"pending","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the instrument. Can only be set if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument can be charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument is pending to be verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument is not active and cannot be charged."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When updating this field, only the following state transitions are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"active --> inactive\npending --> active (only for payment instrument with isExternal=true)\npending --> inactive (only for payment instrument with isExternal=true)\ninactive --> active (only for payment instrument with isExternal=true)\ninactive --> pending (only for payment instrument with isExternal=true)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"active --> inactive\npending --> active (only for payment instrument with isExternal=true)\npending --> inactive (only for payment instrument with isExternal=true)\ninactive --> active (only for payment instrument with isExternal=true)\ninactive --> pending (only for payment instrument with isExternal=true)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if you update the status from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will clear the following attributes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactiveReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deletedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureDescriptionShort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureDescriptionLong"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","inactive","pending"],"type":"string"},"verified":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the instrument has been verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:skip.verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the payment instrument must be marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/BankAccountImmutableFields":{"id":"components/schemas/BankAccountImmutableFields","kind":"json-schema","title":"BankAccountImmutableFields","data":{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}$","readOnly":true,"type":"string"},"instrumentType":{"enum":["bankAccount"],"type":"string"},"routingNumber":{"description":"The routing number.","type":"string"}},"type":"object"}},"components/schemas/AccountLinkError":{"id":"components/schemas/AccountLinkError","kind":"json-schema","title":"AccountLinkError","data":{"properties":{"errorCodeByVendor":{"description":"The error code as received from the vendor.","type":"string"},"errorDescriptionBorrower":{"description":"The error description as received from the vendor for presentation to the borrower.","type":"string"},"errorDescriptionInternal":{"description":"The internal error description as received from the vendor.","type":"string"},"errorType":{"description":"The error type. This describes the appropriate way to handle the error.","enum":["retry","relink","outage"],"type":"string"},"errorTypeByVendor":{"description":"The error type as received from the vendor.","type":"string"}},"type":"object"}},"components/schemas/AccountLink":{"id":"components/schemas/AccountLink","kind":"json-schema","title":"AccountLink","data":{"description":"An object representing a link with a third party vendor (e.g. Plaid) that allows fetching additional account details.","properties":{"accessToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The vendor's access token for initial access. With Plaid, this can be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided by Plaid Link, or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided after exchanging the public token."},"children":[]}]}]}],"type":"string"},"accountId":{"description":"The identifier used to identify an account with the data vendor.","type":"string"},"dataServices":{"default":["accountInfo"],"description":"A list of data services available with this link.","items":{"enum":["accountInfo","balance"],"type":"string"},"type":"array"},"errorCommunicationsSent":{"description":"The number of times the user has been notified that the account link has failed and needs to be recreated.","readOnly":true,"type":"integer"},"itemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The vendor's item identifier. With Plaid, this is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"lastErrorCommunicationAt":{"description":"The date and time that the most recent error notification was sent to the user.","format":"date-time","readOnly":true,"type":"string"},"recentError":{"allOf":[{"description":"The most recent error that occurred while fetching data from this link."},{"$ref":"#/components/schemas/AccountLinkError"}]},"status":{"description":"The status of the account link.","enum":["active","inactive"],"type":"string"},"vendor":{"description":"The data vendor identifier.","enum":["plaid"],"type":"string"}},"required":["vendor","accessToken","accountId"],"type":"object"}},"components/schemas/BankAccountMutableFields":{"id":"components/schemas/BankAccountMutableFields","kind":"json-schema","title":"BankAccountMutableFields","data":{"properties":{"accountHolderName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts, the full name of the account holder. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts, the business name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not an account nickname. It should match the name on file for the account with the bank."},"children":[]}]}]}]}],"type":"string"},"accountHolderType":{"description":"Type of entity that is the account holder.","enum":["business","personal"],"type":"string"},"accountLink":{"$ref":"#/components/schemas/AccountLink"},"accountType":{"description":"Type of the account.","enum":["checking","savings"],"type":"string"},"institutionName":{"description":"The name of the financial institution where this account resides. If empty, will default to the name associated\nwith the routing number.\n","maxLength":36,"type":"string"}},"type":"object"}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"Bank Account","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentFailureReasons"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"$ref":"#/components/schemas/BankAccountImmutableFields"},{"$ref":"#/components/schemas/BankAccountMutableFields"}],"required":["accountHolderName","accountHolderType","accountNumber","accountType","instrumentType","routingNumber"],"title":"Bank Account"}},"components/schemas/bankAccountAccountNumber":{"id":"components/schemas/bankAccountAccountNumber","kind":"json-schema","title":"bankAccountAccountNumber","data":{"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the last two, three, or four digits of the account number can be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide four digits if available, otherwise provide two or three digits."},"children":[]}]}]}],"pattern":"^[0-9]+$","type":"string","writeOnly":true}},"required":["accountNumber"],"type":"object"}},"components/schemas/SettlementInstrument":{"id":"components/schemas/SettlementInstrument","kind":"json-schema","title":"SettlementInstrument","data":{"allOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/bankAccountAccountNumber"},{"properties":{"investorId":{"description":"Public ID of the investor.","readOnly":true,"type":"string"},"verified":{"readOnly":true}},"type":"object"}]}},"components/schemas/BankAccountMutable":{"id":"components/schemas/BankAccountMutable","kind":"json-schema","title":"Bank Account","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"$ref":"#/components/schemas/BankAccountMutableFields"}],"title":"Bank Account"}},"components/schemas/SettlementInstrumentMutable":{"id":"components/schemas/SettlementInstrumentMutable","kind":"json-schema","title":"SettlementInstrumentMutable","data":{"allOf":[{"$ref":"#/components/schemas/BankAccountMutable"},{"type":"object"}]}},"components/schemas/LoanIdsResponse":{"id":"components/schemas/LoanIdsResponse","kind":"json-schema","title":"LoanIdsResponse","data":{"properties":{"loanIds":{"description":"The list of loans which have the specified label(s) and match the path and query parameters.\n","items":{"type":"string"},"maxItems":100,"type":"array"}},"type":"object"}},"components/schemas/LoanIdsRequest":{"id":"components/schemas/LoanIdsRequest","kind":"json-schema","title":"LoanIdsRequest","data":{"properties":{"loanIds":{"description":"The unique identifier of the loans. Can be Peach or lender's external identifier.\n","items":{"type":"string"},"maxItems":100,"type":"array"}},"type":"object"}},"components/schemas/LoanTapeFields":{"id":"components/schemas/LoanTapeFields","kind":"json-schema","title":"Loan Tape Fields","data":{"items":{"enum":["reportDate","investorId","investorLegalName","investorOwnershipPercentage","secondInvestorId","secondInvestorLegalName","secondInvestorOwnershipPercentage","loanId","loanStatus","loanExternalId","loanType","loanTypeId","mainBorrowerId","mainBorrowerExternalId","currentCreditLimit","activationDate","lastDueDate","effectiveAPR","interestRate","indexRate","promoRate","interestType","contractualRecurringAmount","amountFinanced","firstDueDateExpectedAmount","firstDueDatePaymentAmountByDueDate","upcomingDueDate","upcomingDueDateExpectedAmount","outstandingBalanceTotalAmount","outstandingBalancePrincipalAmount","outstandingBalanceInterestAmount","outstandingBalanceFeesAmount","creditsAppliedTotalAmount","paymentsMadeTotalAmount","paymentsMadePrincipalAmount","paymentsMadeInterestAmount","paymentsMadeFeesAmount","paymentsMadeOverAmount","paymentsMadeReimbursementsAmount","lastSuccessfulPaymentEffectiveDate","lastSuccessfulPaymentTotalAmount","lastSuccessfulPaymentPrincipalAmount","lastSuccessfulPaymentInterestAmount","lastSuccessfulPaymentFeesAmount","isAutopayOn","recentAutopayAuthorizationDate","isOverdue","overdueNumberDays","overdueBalanceTotalAmount","overdueBalancePrincipalAmount","overdueBalanceInterestAmount","overdueBalanceFeesAmount","nonDueBalanceTotalAmount","nonDueBalancePrincipalAmount","nonDueBalanceInterestAmount","nonDueBalanceFeesAmount","dailyInterestAccruedAmount","dailyInterestDiscountAmount","dailyForgoneInterestCapAmount","dueBalanceTotalAmount","dueBalancePrincipalAmount","dueBalanceInterestAmount","dueBalanceFeesAmount","timesOverdue15Days","timesOverdue30Days","timesOverdue60Days","timesOverdue90Days","timesOverdue120Days","isChargedOff","chargedOffDate","chargedOffPrincipalAmount","chargedOffInterestAmount","chargedOffFeesAmount","chargedOffTotalAmount","chargedOffReason","netInterestAccruedTotalAmount","interestDiscountTotalAmount","forgoneInterestCapAmount","reimbursementAmount","mainBorrowerFirstName","mainBorrowerLastName","mainBorrowerDateOfBirth","mainBorrowerIdentityType","mainBorrowerIdentityValue","mainBorrowerIdentityIssuingCountry","mainBorrowerIdentityIssueDate","mainBorrowerIdentityExpirationDate","mainBorrowerBusinessLegalName","mainBorrowerBusinessType","isInSCRAStatus","activeDutyStartDate","activeDutyEndDate","isInBankruptcy","bankruptcyFiledDate","bankruptcyCourtCaseNumber","bankruptcyLastStatus","bankruptcyDisposition","bankruptcyChapter","currentAddressState","currentAddressPostalCode","currentAddressLine1","currentAddressLine2","currentAddressCity","currentAddressCountry","currentEmail","currentPhone","refundedAmount","merchantId","merchantBusinessName","originalDuration","originalPaymentFrequency","currentPaymentFrequency","currentRecurringAmount","paidOffDate","loanMetaData","isLoanModified","principalAmount","projectedPayoffDate","remainingDuration","dataStatus","overdueOver30DaysBalanceTotalAmount","overdueOver60DaysBalanceTotalAmount","overdueOver90DaysBalanceTotalAmount","overdueOver120DaysBalanceTotalAmount","overdueOver150DaysBalanceTotalAmount","overdueOver180DaysBalanceTotalAmount","nonDueBalanceOriginationFeesAmount","nonDueBalanceDrawFeesAmount","nonDueBalanceLateFeesAmount","nonDueBalanceModificationFeesAmount","dueBalanceOriginationFeesAmount","dueBalanceDrawFeesAmount","dueBalanceLateFeesAmount","dueBalanceModificationFeesAmount","originationFeeAmount","overdueBalanceOriginationFeesAmount","overdueBalanceDrawFeesAmount","overdueBalanceLateFeesAmount","overdueBalanceModificationFeesAmount","outstandingBalanceOriginationFeesAmount","outstandingBalanceDrawFeesAmount","outstandingBalanceLateFeesAmount","outstandingBalanceModificationFeesAmount","nonDueBalanceMembershipFeesAmount","dueBalanceMembershipFeesAmount","overdueBalanceMembershipFeesAmount","outstandingBalanceMembershipFeesAmount"],"type":"string"},"title":"Loan Tape Fields","type":"array"}},"components/schemas/PaymentTapeFields":{"id":"components/schemas/PaymentTapeFields","kind":"json-schema","title":"Payment Tape Fields","data":{"items":{"enum":["reportDate","loanId","loanExternalId","investorId","investorLegalName","investorOwnershipPercentage","secondInvestorId","secondInvestorLegalName","secondInvestorOwnershipPercentage","transactionId","transactionExternalId","status","effectiveDate","totalAmount","principalAmount","interestAmount","feesAmount","unappliedAmount","paymentMethodType","processingFeeType","processingFeeAmount","isReversal","isReimbursement","reversingTransactionId","reversingTransactionExternalId","settlementId","settlementDate"],"type":"string"},"title":"Payment Tape Fields","type":"array"}},"components/schemas/BaseLoanTapeType":{"id":"components/schemas/BaseLoanTapeType","kind":"json-schema","title":"BaseLoanTapeType","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"actionOnMissingData":{"default":"excludeFromTape","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to various circumstances, it is possible that not all data needed to produce a given loan tape"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be available at the time of tape generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this situation, there are three options for how these records will be represented in a tape:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeIDsAndEmptyData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (recommended) - The tape will include records that have missing data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" columns will be populated, assuming they are configured)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeFromTape"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Records with missing data will be dropped completely from the tape."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By choosing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeFromTape"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lenders will be responsible for validating number of loans included within tapes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failTape"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (loan tapes only) - If a snapshot is still missing after the tape worker's retry"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window, the entire tape record fails and nothing is delivered rather than shipping a partial"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or reduced file. This setting has no effect on payment tapes, which never read snapshots."},"children":[]}]}]}]}]}],"enum":["includeIDsAndEmptyData","excludeFromTape","failTape"],"type":"string"},"compressionType":{"default":"gzip","description":"Compression type used for result file.\n","enum":["noCompression","gzip","zip"],"type":"string"},"fieldNameMappings":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapping of fields from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to field names used in the bank/investor's system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"investorId\": \"investor_id\", \"isChargedOff\": \"loan_charged_off\"}"},"children":[]}]}]}],"type":"object"},"fields":{"anyOf":[{"$ref":"#/components/schemas/LoanTapeFields"},{"$ref":"#/components/schemas/PaymentTapeFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of fields to be included in a specific tape. There are two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tapeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you choose a list of fields, make sure to include only the values corresponding to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tapeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tapeType=loans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot have an attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because that field is only relevant to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tapeType=payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanMetaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - is a special field. If included, the caller must provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanMetaDataFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerIdentityValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - is the borrower's identity number such as SSN, ITIN, tax ID, FEIN, etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is encrypted in Peach system. If you want to export that value in loan tapes, you must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encryptionMethod"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set when you call \"Create loan tape\". In other words, loan tape must be encrypted in order to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"populate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mainBorrowerIdentityValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"loanMetaDataFields":{"default":[],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys/values to be included in a specific tape."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute consists of key/value pairs in the form of a JSON dictionary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanMetaDataFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be provided if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanMetaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the fields list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the key cannot be found in the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute, the tape will populate the column name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(aka key) but will not populate the value (aka the value will be empty)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If found, each column name will be the \"key\" + \"LoanMetaData\" and the value will be the \"value\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search/look up of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanMetaDataFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key in the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is case-sensitive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach doesn't know what data is provided in the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute, and we don't check validity of the key/value pairs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's lender/caller responsibility to make sure that the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute has valid and formatted values."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"moneyUnit":{"default":"subUnit100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subUnit100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount fields in loan tapes will be in pennies. For example: 100 means $1.00 (one dollar)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount fields in loan tapes will be in decimal format with 2 places after the decimal point."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: 32.45 is thirty-two dollars and forty-five cents."},"children":[]}]}]}],"enum":["fullUnit","subUnit100"],"type":"string"},"reportDaysWhenPaidOff":{"default":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of days to report a loan after it was changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure you check that your loan types are configured to generate snapshots for number of days that is greater than reportDaysWhenPaidOff for loans that are in paidOff status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your company has many loan types, please check them all."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loans without snapshots data cannot be reported in the loan tape"},"children":[]}]}]}],"minimum":10,"type":"integer"},"shouldReportDrawsSeparately":{"default":false,"description":"Indicates whether LOC Draws should be reported as separate rows in loan tape. LOC will always be reported on an aggregated level.\n","type":"boolean"},"tapeName":{"description":"A friendly name for the tape.\n","type":"string"},"tapeOutputFormat":{"default":"CSV","description":"The tape output format.","enum":["CSV"],"type":"string"}},"type":"object"}]}},"components/schemas/TapeType":{"id":"components/schemas/TapeType","kind":"json-schema","title":"TapeType","data":{"allOf":[{"$ref":"#/components/schemas/BaseLoanTapeType"},{"properties":{"tapeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan tape type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the tape includes information about accounts (e.g. loans)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the tape includes information about payments made by borrowers."},"children":[]}]}]}],"enum":["loans","payments"],"type":"string"}},"type":"object"}]}},"components/schemas/LoanTape":{"id":"components/schemas/LoanTape","kind":"json-schema","title":"LoanTape","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"activatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UTC timestamp when the tape was first set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Null if still in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or for tapes created before this field was introduced."},"children":[]}]}]}],"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"customFileName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, will override the default file name for new loan tape files created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time placeholders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used, along with the following placeholders:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{loanTapeId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the loan tape ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{loanTapeTypeId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the loan tape type ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan_tape_{{loanTapeId}}_%m_%d_%Y.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan_tape_TA-DJEK-CVDE_02_12_2022.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when generated."},"children":[]}]}]}],"nullable":true,"type":"string"},"dateForCustomFileName":{"default":"dateOfGeneration","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the date value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFileName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Uses the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the loan tape record"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfGeneration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Uses the date when the loan tape record was generated"},"children":[]}]}]}]}],"enum":["reportDate","dateOfGeneration"],"nullable":true,"type":"string"},"encryptionMethod":{"description":"The encryption method that Peach system with use to encrypt the files.\n","enum":["GPG"],"nullable":true,"type":"string"},"investorId":{"description":"The investor ID.","nullable":true,"type":"string"},"loanTapeTypeId":{"description":"The loan tape type ID.","type":"string"},"publicKey":{"description":"The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.","nullable":true,"type":"string"},"sftpAccessMethod":{"default":"usernamePassword","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usernamePassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpUsername"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpPassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPrivateKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created by peach."},"children":[]}]}]}],"enum":["usernamePassword","keys"],"type":"string"},"sftpCdDir":{"description":"Change directory into this folder before performing the upload.\n","nullable":true,"type":"string"},"sftpHostname":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hostname for SFTP."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host name should not contain a scheme, so don't put "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftp://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the front. You may optionally specify a port like so: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com:222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no port is supplied a default of 22 will be used."},"children":[]}]}]}],"pattern":"^[^/]+$","type":"string"},"sftpPassword":{"description":"The password for SFTP.","type":"string"},"sftpSSHPeachPublicKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach public key to be used when log into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpHostname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value can be only be set by the Peach team."},"children":[]}]}]}],"readOnly":true,"type":"string"},"sftpUsername":{"description":"The username for SFTP.","type":"string"},"status":{"default":"active","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the loan tape."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The tape is being configured. Results will not be monitored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The tape is live. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records when it was first activated."},"children":[]}]}]}]}],"enum":["draft","active"],"type":"string"}},"type":"object"}]}},"components/schemas/LoanTapeRecord":{"id":"components/schemas/LoanTapeRecord","kind":"json-schema","title":"LoanTapeRecord","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"failureDescription":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable explanation when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Empty otherwise."},"children":[]}]}]}],"type":"string"},"investorId":{"description":"The investor ID.","nullable":true,"type":"string"},"loanTapeId":{"description":"The loan tape ID.","type":"string"},"loanTapeTypeId":{"description":"The loan tape type ID.","type":"string"},"reportDate":{"format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the loan tape generation job."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": generation is in progress (the record was created when the job was triggered and has not yet reached a terminal state)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the tape was generated (and uploaded, if configured) successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": generation failed; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the tape file was generated but has not yet been uploaded to the configured SFTP destination"},"children":[]}]}]}]}],"enum":["succeeded","failed","created"],"nullable":true,"type":"string"},"tapeFileName":{"type":"string"}},"type":"object"}]}},"components/schemas/RepaymentNotificationTrigger":{"id":"components/schemas/RepaymentNotificationTrigger","kind":"json-schema","title":"RepaymentNotificationTrigger","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the conditions that trigger a communication. NOTE: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayExpectedPaymentChangedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will never occur for LOC,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"because autopays are finalized after the statement date and not updated again."},"children":[]}]}]}],"enum":["autopayFirstPayment","autopayExpectedPayment","autopayExpectedPaymentChangedAmount","cardExpiration","expectedPayment","futurePayment","loginFirstPayment","loanOverdue","loanRightToCure","promoProgramReminder","promoProgramEligibilityAtRisk"],"example":"expectedPayment","readOnly":true,"type":"string"}},"components/schemas/RepaymentEngineInteractionSubject":{"id":"components/schemas/RepaymentEngineInteractionSubject","kind":"json-schema","title":"RepaymentEngineInteractionSubject","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InteractionSubject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification that is sent to the borrower."},"children":[]}]}]}],"enum":["autopayAmountChanged","autopayEnableReminder","autopayPaymentReminder","cardExpiresReminder","futurepayPaymentDueReminder","loanOverdueFirstNotice","loanOverdueSecondNotice","loanOverdueThirdNotice","loanOverdueFourthNotice","loanOverdueFifthNotice","loanOverdueSixthNotice","loanRightToCurePersonalUnsecured","loginFirstPaymentReminder","paymentDueDateReminder","promoProgramReminder","promoProgramEligibilityAtRisk"],"example":"paymentDueDateReminder","type":"string"}},"components/schemas/ValidInteractionChannel":{"id":"components/schemas/ValidInteractionChannel","kind":"json-schema","title":"ValidInteractionChannel","data":{"enum":["email","text","mail"],"type":"string"}},"components/schemas/DaysOffsetDueDate":{"id":"components/schemas/DaysOffsetDueDate","kind":"json-schema","title":"DaysOffsetDueDate","data":{"oneOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days offset from the due date that a notification is sent. Should be negative for reminders and positive for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overdue notices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject=loanRightToCurePersonalUnsecured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.rightToCureBuffer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compute the offset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject=autopayAmountChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.autopay.amountChangeNotificationBuffer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to compute the offset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject=promoProgramReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramEligibilityAtRisk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the reminder will trigger "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daysOffsetDueDate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PromoProgram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end date, which is why the value should be negative for the reminder and positive for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramEligibilityAtRisk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":-5,"nullable":true,"type":"integer"},{"description":"This object controls the exact date on which the loanOverdue reminder is sent. Note that the offsets are absolute.\n","properties":{"everyTwoWeeks":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification type has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDueDatesAvailableEveryTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true on this loan type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this offset will be used for loans with payments that are due every two weeks."},"children":[]}]}]}],"type":"integer"},"monthly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification type has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDueDatesAvailableTwiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true on this loan type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this offset will be used for loans with monthly payments."},"children":[]}]}]}],"type":"integer"},"singleTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification type has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDueDatesAvailableSingleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true on this loan type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this offset will be used for loans with a single term payment."},"children":[]}]}]}],"type":"integer"},"twiceMonthly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification type has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDueDatesAvailableTwiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true on this loan type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this offset will be used for loans with twice monthly payments."},"children":[]}]}]}],"type":"integer"},"weekly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification type has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDueDatesAvailableWeekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true on this loan type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then this offset will be used for loans with weekly payments."},"children":[]}]}]}],"type":"integer"}},"type":"object"}]}},"components/schemas/RepaymentNotificationTypeWithoutSubject":{"id":"components/schemas/RepaymentNotificationTypeWithoutSubject","kind":"json-schema","title":"RepaymentNotificationTypeWithoutSubject","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"companyId":{"description":"The company identifier for this notification type.","readOnly":true,"type":"string"},"dayType":{"$ref":"#/components/schemas/DayType"},"daysOffsetDueDate":{"$ref":"#/components/schemas/DaysOffsetDueDate"},"loanOverdueWindow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Window in which to start sending this notification. Only used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger=loanOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"from":{"description":"Days after the loan is overdue to start sending this notification type.\n","example":0,"type":"integer"},"to":{"description":"Days after the loan is overdue to stop sending this notification type.\n","example":30,"type":"integer"}},"readOnly":true,"required":["from","to"],"type":"object"},"loanTypeAssetName":{"type":"string"},"productId":{"type":"string"},"promoType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used for notifications with subject "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramReminder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramEligibilityAtRisk"},"children":[]}]}]}],"enum":["sameAsCash"],"nullable":true,"type":"string"},"sendChannels":{"default":["email","text"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channels to send the notification to. By default, the notification is sent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system always attempts to send to "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified channels. As long as at least one contact of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified channels is available to send to then the notification will considered successful. An error is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thrown if all three channels are unavailable for the borrower."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ValidInteractionChannel"},"type":"array"},"status":{"enum":["active","inactive"],"type":"string"},"trigger":{"$ref":"#/components/schemas/RepaymentNotificationTrigger"}},"type":"object"}]}},"components/schemas/RepaymentNotificationType":{"id":"components/schemas/RepaymentNotificationType","kind":"json-schema","title":"RepaymentNotificationType","data":{"allOf":[{"properties":{"subject":{"$ref":"#/components/schemas/RepaymentEngineInteractionSubject"}},"type":"object"},{"$ref":"#/components/schemas/RepaymentNotificationTypeWithoutSubject"}]}},"components/schemas/ResponseEndDate":{"id":"components/schemas/ResponseEndDate","kind":"json-schema","title":"ResponseEndDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the promise to pay plan, equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of plan's last promise period."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/ExternalId":{"id":"components/schemas/ExternalId","kind":"json-schema","title":"ExternalId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for a promise to pay plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"nullable":true,"type":"string"}},"components/schemas/ResponseStartDate":{"id":"components/schemas/ResponseStartDate","kind":"json-schema","title":"ResponseStartDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the promise to pay plan, equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of plan's first promise period."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/PromiseToPayPlan":{"id":"components/schemas/PromiseToPayPlan","kind":"json-schema","title":"PromiseToPayPlan","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"cancellationReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for canceling the promise to pay plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceledByUser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Promise to pay plan was canceled by an agent or borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanChargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was charged off during the promise period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanAccelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was accelerated during the promise period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPromisePlanOffered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - another promise plan was offered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - for any other reason requiring cancellation."},"children":[]}]}]}],"enum":["canceledByUser","loanChargedOff","loanAccelerated","otherPromisePlanOffered","other"],"nullable":true,"type":"string"},"caseId":{"description":"The ID of the case associated with the promise to pay plan.","nullable":true,"type":"string"},"companyId":{"description":"The unique company identifier.","type":"string"},"endDate":{"$ref":"#/components/schemas/ResponseEndDate"},"externalId":{"$ref":"#/components/schemas/ExternalId"},"id":{"description":"The promise to pay plan ID.","type":"string"},"isOverdue":{"description":"The borrower has not met one or more promised amounts by the promised due date.","type":"boolean"},"loanId":{"description":"The unique loan identifier that the promise belongs to.","type":"string"},"object":{"default":"promiseToPayPlan","enum":["promiseToPayPlan"],"readOnly":true,"type":"string"},"reasonDetails":{"description":"Additional details about the reason for canceling the promise to pay plan.","nullable":true,"type":"string"},"schedule":{"description":"Promise to pay plan periodId(s) and amount(s).","items":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"amount":{"description":"Amount of the promise to pay period.","format":"float","type":"number"},"dueDate":{"description":"The due date of the promised amount.","format":"date","type":"string"},"object":{"default":"promisePeriod","enum":["promisePeriod"],"readOnly":true,"type":"string"},"periodId":{"description":"Unique identifier of the period created for the promise to pay plan.","type":"string"},"startDate":{"description":"The period start date.","format":"date","type":"string"}},"type":"object"}]},"type":"array"},"startDate":{"$ref":"#/components/schemas/ResponseStartDate"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the promise to pay plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - promise to pay has been created but has not yet started. Typically used when the lender wants to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start a promise as of a specific date. Communications will not be triggered and tasks will not be assigned to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"agents for promise to pay plans in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Peach's system will transition the status of the promise"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pay plan to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless the lender cancels the promise to pay beforehand."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - promise to pay plan is in effect. To check if the borrower is on and behind the schedule, see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" isOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - promise to pay final period end date has passed and the borrower has met the promised amount(s) by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promise's final period end date. This status is a terminal state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - promise to pay final period end date has passed and the borrower has not met the promised amount(s)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the promise's final period end date. This status is a terminal state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - promise to pay plan was canceled. This status is a terminal state."},"children":[]}]}]}],"enum":["scheduled","active","kept","broken","canceled"],"type":"string"}},"type":"object"}]}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"address":{"$ref":"#/components/schemas/AddressBase","description":"The mailing address."},"businessName":{"description":"The business name of the merchant. Can be displayed in UI.\n","type":"string"},"businessTypeDisplayName":{"description":"The business type/description as shown to borrowers. For\nexample: 'Merchant', 'Dealer', or 'Venue'. Defaults to\n'Merchant' if no value is provided.\n","type":"string"},"disputesContactEmail":{"description":"The email of the merchant's disputes department.\n","maxLength":320,"type":"string"},"disputesContactName":{"description":"The name of the merchant's disputes department.\n","maxLength":256,"type":"string"},"disputesContactPhone":{"description":"The phone number of the merchant's disputes department.\n","maxLength":15,"type":"string"},"externalId":{"description":"A lender's identifier for the merchant.\n","type":"string"},"parentMerchantId":{"description":"The parent merchant identifier. Used to represent hierarchy of merchant sub entities.\nCan be Peach or lender's external identifier.\n","nullable":true,"type":"string"},"primaryContactEmail":{"description":"The email of the merchant's primary contact person or department.\n","maxLength":320,"type":"string"},"primaryContactName":{"description":"The name of the merchant's primary contact person or department.\n","maxLength":256,"type":"string"},"primaryContactPhone":{"description":"The phone number of the merchant's primary contact person or department.\n","maxLength":15,"type":"string"},"subEntityname":{"description":"The sub entity business name of the merchant. For example: Online Sephora.\n","type":"string"}},"type":"object"}]}},"components/schemas/fileName":{"id":"components/schemas/fileName","kind":"json-schema","title":"fileName","data":{"description":"The name of the ACH file.\n","minLength":1,"type":"string"}},"components/schemas/AchFileUploadDetails":{"id":"components/schemas/AchFileUploadDetails","kind":"json-schema","title":"AchFileUploadDetails","data":{"allOf":[{"properties":{"uploadFailedAt":{"description":"The datetime when the upload of the ACH file failed.\n","format":"date-time","nullable":true,"type":"string"},"uploadNumberOfRetries":{"default":0,"description":"The number of upload retries for the ACH file.\n","minimum":0,"nullable":true,"type":"integer"},"uploadStartedAt":{"description":"The datetime when the upload of the ACH file began.\n","format":"date-time","nullable":true,"type":"string"},"uploadSucceededAt":{"description":"The datetime when the upload of the ACH file finished successfully.\n","format":"date-time","nullable":true,"type":"string"}},"type":"object"}]}},"components/schemas/AchFileMutableFields":{"id":"components/schemas/AchFileMutableFields","kind":"json-schema","title":"AchFileMutableFields","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"fileName":{"$ref":"#/components/schemas/fileName"},"gcp":{"allOf":[{"$ref":"#/components/schemas/AchFileUploadDetails"}],"description":"GCP Storage upload details"},"isSettlement":{"default":false,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the file contains only settlement transactions with investors. These files"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are generated only for the Peach payment processor as part of automated investor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reconciliation; third-party processors do not produce settlement ACH files."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, the file contains only transactions with borrowers."},"children":[]}]}]}]}],"type":"boolean"},"numberOfMicrodeposits":{"default":0,"description":"The number of microdeposits included in this ACH file.\n","minimum":0,"type":"integer"},"numberOfTransactions":{"default":0,"description":"The number of transactions included in this ACH file.\n","minimum":0,"type":"integer"},"sftp":{"allOf":[{"$ref":"#/components/schemas/AchFileUploadDetails"}],"description":"SFTP Server upload details"}},"type":"object"}]}},"components/schemas/AchFile":{"id":"components/schemas/AchFile","kind":"json-schema","title":"ACH File","data":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/AchFileMutableFields"}],"required":["fileName"],"title":"ACH File"}},"components/schemas/FundingInstrument":{"id":"components/schemas/FundingInstrument","kind":"json-schema","title":"FundingInstrument","data":{"allOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/bankAccountAccountNumber"},{"properties":{"balanceCheck":{"properties":{"bypass":{"type":"boolean"}},"required":["bypass"],"type":"object"},"verified":{"readOnly":true}},"type":"object"}]}},"components/schemas/FundingInstrumentMutable":{"id":"components/schemas/FundingInstrumentMutable","kind":"json-schema","title":"FundingInstrumentMutable","data":{"allOf":[{"$ref":"#/components/schemas/BankAccountMutable"},{"type":"object"}]}},"components/schemas/WorkflowStepStatus":{"id":"components/schemas/WorkflowStepStatus","kind":"json-schema","title":"WorkflowStepStatus","data":{"enum":["due","approved","rejected","skipped"],"type":"string"}},"components/schemas/CaseApprovalConditions":{"id":"components/schemas/CaseApprovalConditions","kind":"json-schema","title":"CaseApprovalConditions","data":{"description":"Set of steps' statuses that must be met before case outcome can be set\nto approved. Currently, we support \"and\" only between the steps.\n","items":{"properties":{"stepStatus":{"$ref":"#/components/schemas/WorkflowStepStatus"},"stepTypeRefId":{"format":"uuid","type":"string"}},"type":"object"},"nullable":true,"type":"array"}},"components/schemas/DecisionQuestionType":{"id":"components/schemas/DecisionQuestionType","kind":"json-schema","title":"DecisionQuestionType","data":{"enum":["yesNo","approveReject"],"type":"string"}},"components/schemas/StatusChangeHistory":{"id":"components/schemas/StatusChangeHistory","kind":"json-schema","title":"StatusChangeHistory","data":{"description":"The status change history of workflow steps and work items.\n","items":{"additionalProperties":false,"properties":{"status":{"type":"string"},"time":{"format":"date-time","type":"string"},"user":{"type":"integer"}},"type":"object"},"type":"array"}},"components/schemas/StepVisibility":{"id":"components/schemas/StepVisibility","kind":"json-schema","title":"StepVisibility","data":{"enum":["normal","closingApproved","closingDenied","closingFalsePositive","closingNoOutcome"],"type":"string"}},"components/schemas/WorkflowWorkitemStatus":{"id":"components/schemas/WorkflowWorkitemStatus","kind":"json-schema","title":"WorkflowWorkitemStatus","data":{"enum":["due","completed","skipped"],"type":"string"}},"components/schemas/WorkflowWorkitem":{"id":"components/schemas/WorkflowWorkitem","kind":"json-schema","title":"WorkflowWorkitem","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"completedAt":{"format":"date-time","nullable":true,"type":"string"},"descriptionLong":{"nullable":true,"type":"string"},"descriptionShort":{"type":"string"},"history":{"$ref":"#/components/schemas/StatusChangeHistory"},"object":{"default":"workflowWorkitem","enum":["workflowWorkitem"],"readOnly":true,"type":"string"},"skippedAt":{"format":"date-time","nullable":true,"type":"string"},"status":{"$ref":"#/components/schemas/WorkflowWorkitemStatus"},"updatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user who last updated this work item.\nCan be an agent or automated system process.\n"},"workflowStepId":{"type":"string"},"workflowWorkitemTypeId":{"type":"string"}},"type":"object"}]}},"components/schemas/WorkflowStep":{"id":"components/schemas/WorkflowStep","kind":"json-schema","title":"WorkflowStep","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"completedAt":{"format":"date-time","nullable":true,"type":"string"},"decisionQuestion":{"description":"Decision question that leads to the outcome of the step.\n","type":"string"},"decisionQuestionType":{"$ref":"#/components/schemas/DecisionQuestionType"},"descriptionLong":{"description":"Additional details on how to complete the step.\n","nullable":true,"type":"string"},"descriptionShort":{"description":"A short description of the step. Displayed to agents in the UI.\n","type":"string"},"history":{"$ref":"#/components/schemas/StatusChangeHistory"},"mandatory":{"type":"boolean"},"object":{"default":"workflowStep","enum":["workflowStep"],"readOnly":true,"type":"string"},"skippedAt":{"format":"date-time","nullable":true,"type":"string"},"status":{"$ref":"#/components/schemas/WorkflowStepStatus"},"updatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user who last updated this workflow step.\nCan be an agent or automated system process.\n"},"visibility":{"$ref":"#/components/schemas/StepVisibility"},"workItems":{"description":"List of work items that comprise this workflow step.\n","items":{"$ref":"#/components/schemas/WorkflowWorkitem"},"type":"array"},"workflowId":{"type":"string"},"workflowStepTypeId":{"type":"string"}},"type":"object"}]}},"components/schemas/Workflow":{"id":"components/schemas/Workflow","kind":"json-schema","title":"Workflow","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"approvalConditions":{"$ref":"#/components/schemas/CaseApprovalConditions"},"completedAt":{"format":"date-time","nullable":true,"type":"string"},"description":{"description":"Description of the workflow.","type":"string"},"name":{"description":"Short name of the workflow.\n","type":"string"},"object":{"default":"workflow","enum":["workflow"],"readOnly":true,"type":"string"},"steps":{"description":"List of workflow steps that comprise the workflow.\n","items":{"$ref":"#/components/schemas/WorkflowStep"},"type":"array"},"workflowTypeId":{"type":"string"}},"type":"object"}]}},"components/schemas/LoanInvestorsPaging":{"id":"components/schemas/LoanInvestorsPaging","kind":"json-schema","title":"LoanInvestorsPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"$ref":"#/components/schemas/LoanInvestorsGet"}},"type":"object"}]}},"components/schemas/PromoProgramTypeFields":{"id":"components/schemas/PromoProgramTypeFields","kind":"json-schema","title":"PromoProgramTypeFields","data":{"properties":{"archived":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the promo program type has been archived. Derived from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status == archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"archivedAt":{"description":"When the promo program type was archived.","format":"date-time","readOnly":true,"type":"string"},"archivedBy":{"description":"The identifier of the user who archived the promo program type.","readOnly":true,"type":"string"},"createdAt":{"description":"When the promo program type was created.","format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"description":"When the promo program type was deleted, if applicable.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"description":{"description":"A legal description of the promotional program as it should\nbe communicated and shown to borrowers.\nIf the description is provided, borrowers will see the\ndescription in the App / Borrower Portal and/or on\nstatements.\n","maxLength":10000,"type":"string"},"displayName":{"description":"The promotional program name as it is shown to borrowers in\nthe App / Borrower Portal and/or on statements.\n","type":"string"},"externalId":{"description":"A lender's unique identifier for a specific promotional\nprogram type.\n","type":"string"},"id":{"description":"The promotional program type's unique identifier.","readOnly":true,"type":"string"},"metaData":{"description":"Store any type of key/value pairs in the form of a JSON\ndictionary.\n","nullable":true,"type":"object"},"status":{"default":"draft","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promo type status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new type is normally created in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you are ready to offer the promotional program type on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loans, update the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the promotional program"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be used on new loans. Loans in-flight will continue to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the legacy equivalent of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is never returned in responses (such rows serialize as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and is rejected as a write value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a terminal state set via the archive (DELETE)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint, not via update. Archived types cannot be edited."},"children":[]}]}]}],"enum":["draft","active","deprecated","inactive","archived"],"type":"string"},"updatedAt":{"description":"When the promo program type was last updated.","format":"date-time","readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/PromoProgramTypePaging":{"id":"components/schemas/PromoProgramTypePaging","kind":"json-schema","title":"PromoProgramTypePaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PromoProgramTypeFields"},"type":"array"}},"type":"object"}]}},"components/schemas/PromoType":{"id":"components/schemas/PromoType","kind":"json-schema","title":"PromoType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sameAsCash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - presently only available for installment loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredInterest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - presently only available for Lines of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit / Draws."},"children":[]}]}]}],"enum":["sameAsCash","deferredInterest"],"type":"string"}},"components/schemas/PromoProgramTypePost":{"id":"components/schemas/PromoProgramTypePost","kind":"json-schema","title":"PromoProgramTypePost","data":{"allOf":[{"required":["promoType","displayName"]},{"properties":{"promoType":{"$ref":"#/components/schemas/PromoType"}},"type":"object"},{"$ref":"#/components/schemas/PromoProgramTypeFields"}],"description":"Create a promo program type"}},"components/schemas/PromoProgramTypePut":{"id":"components/schemas/PromoProgramTypePut","kind":"json-schema","title":"PromoProgramTypePut","data":{"allOf":[{"$ref":"#/components/schemas/PromoProgramTypeFields"}],"description":"Create a promo program type"}},"components/schemas/SupercaseType":{"id":"components/schemas/SupercaseType","kind":"json-schema","title":"SupercaseType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The different types of supercases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supercaseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subcaseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supercaseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the type of the supercase and cannot be changed after supercase creation."},"children":[]}]}]}],"enum":["generic","federalEmergency"],"type":"string"}},"components/schemas/TaskWorkerPairingConfig":{"id":"components/schemas/TaskWorkerPairingConfig","kind":"json-schema","title":"TaskWorkerPairingConfig","data":{"properties":{"companyId":{"readOnly":true,"type":"string"},"createdAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"externalId":{"nullable":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"isDefault":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this pairing config is the default for the company. Only one pairing config"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be the default at a time."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"name":{"description":"A human-readable name for this pairing config.\n","type":"string"},"object":{"readOnly":true,"type":"string"},"overrideTwilioTaskWorkflowExpression":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the characteristics of the tasks you wish to match cannot be fully described by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you can override the Twilio \"TaskRouter expression\" used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match the workers by settings this field. (In which case you will see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value set here in the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twilioTaskWorkflowExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as well.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since this syntax is not validated here, it may be difficult to debug invalid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expressions; as such, it is recommended you use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object when possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some useful expression examples for TaskRouter task attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching a task with an email interaction which was sent to the email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support@loans.acme.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction.channel = \"email\" AND \"support@loans.acme.com\" IN interactionMeta.recipients.emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching an inbound phone call to a particular support phone number "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+15555555555"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction.channel = \"voice\" AND interactionMeta.to.phone = \"+15555555555\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[1] https://www.twilio.com/docs/taskrouter/expression-syntax"},"children":[]}]}]}],"type":"string"},"overrideTwilioWorkerQueueExpression":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the characteristics of the workers you wish to match cannot be fully described by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workerMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you can override the Twilio \"TaskRouter expression\" used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match the workers by settings this field. (In which case you will see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value set here in the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twilioWorkerQueueExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as well.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since this syntax is not validated here, it may be difficult to debug invalid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expressions; as such, it is recommended you use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workerMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object when possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[1] https://www.twilio.com/docs/taskrouter/expression-syntax"},"children":[]}]}]}],"type":"string"},"priority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order in which this pairing config should be evaluated. Higher numbers are evaluated first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the default pairing config is always evaluated LAST (and it's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}],"nullable":true,"type":"integer"},"taskMatch":{"properties":{"case":{"properties":{"autocreated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only match tasks with autocreated cases. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match not-autocreated cases. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"caseTypeEnums":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; match any task with a case with a case type matching in the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note this field is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseTypeIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which matches on specific case type instance rather than the case type enum. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any case."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BaseCaseType"},"nullable":true,"type":"array"},"caseTypeIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of case type IDs; match any task with a case with a case type present in the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note this field is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseTypeEnums"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which matches on case type enum rather than a specific case type instance. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"interaction":{"properties":{"channels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interactionChannel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Match any task with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" present in the list. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InteractionChannel"},"nullable":true,"type":"array"},"directions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interactionDirections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Match any task with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" present in the list. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InteractionDirection"},"nullable":true,"type":"array"},"subjects":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interactionSubject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Match any task with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" present in the list. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InteractionSubject"},"nullable":true,"type":"array"},"themes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interactionTheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Match any task with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" present in the list. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InteractionTheme"},"nullable":true,"type":"array"}},"type":"object"},"not":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then match tasks NOT matching those specified in this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Look in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twilioWorkerQueueExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see each individual expression clause"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-ed when this is set.)"},"children":[]}]}]}],"nullable":true,"type":"boolean"},"supercase":{"properties":{"supercaseTypeEnums":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supercaseType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; match any task with a supercase with a supercase type matching in the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any task."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SupercaseType"},"nullable":true,"type":"array"}},"type":"object"},"taskTypes":{"items":{"$ref":"#/components/schemas/TaskType"},"nullable":true,"type":"array"}},"type":"object"},"twilioTaskWorkflowExpression":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Twilio \"TaskRouter Expression\" string used to match tasks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is read-only because it's generated by configuring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, or it's set via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overrideTwilioTaskWorkflowExpression"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field."},"children":[]}]}]}],"readOnly":true,"type":"string"},"twilioWorkerQueueExpression":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Twilio \"TaskRouter expression\" string used to match workers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is read-only because it's generated by configuring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workerMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, or it is set via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overrideTwilioWorkerQueueExpression"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field."},"children":[]}]}]}],"readOnly":true,"type":"string"},"updatedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"workerMatch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object describing the characteristics of the workers to match to the tasks"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matched in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The settings here are translated into Twilio \"expression syntax\"[1] and matched against"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the workers' attributes. You can see the generated expression in the field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twilioWorkerQueueExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[1] https://www.twilio.com/docs/taskrouter/expression-syntax"},"children":[]}]}]}],"properties":{"isManager":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only manager employees. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match only non-manager employees. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match any."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"roleIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of role IDs; match any employee which belongs to at least one of these roles. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"type":"string"},"nullable":true,"type":"array"},"teamIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of team IDs; match any employee which belongs to at least one of these teams. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match any."},"children":[]}]}]}],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}},"components/schemas/TaskWorkerPairingConfigPaging":{"id":"components/schemas/TaskWorkerPairingConfigPaging","kind":"json-schema","title":"TaskWorkerPairingConfigPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/TaskWorkerPairingConfig"},"type":"array"}},"type":"object"}]}},"components/schemas/QueueWaitSplitInnerStatistics":{"id":"components/schemas/QueueWaitSplitInnerStatistics","kind":"json-schema","title":"QueueWaitSplitInnerStatistics","data":{"properties":{"above":{"properties":{"reversations_accepted":{"type":"number"},"tasks_canceled":{"type":"number"}},"type":"object"},"below":{"properties":{"reversations_accepted":{"type":"number"},"tasks_canceled":{"type":"number"}},"type":"object"}},"type":"object"}},"components/schemas/QueueWaitSplitStatistics":{"id":"components/schemas/QueueWaitSplitStatistics","kind":"json-schema","title":"QueueWaitSplitStatistics","data":{"nullable":true,"properties":{"5":{"$ref":"#/components/schemas/QueueWaitSplitInnerStatistics"},"10":{"$ref":"#/components/schemas/QueueWaitSplitInnerStatistics"}},"type":"object"}},"components/schemas/QueueWaitDurationStatistics":{"id":"components/schemas/QueueWaitDurationStatistics","kind":"json-schema","title":"QueueWaitDurationStatistics","data":{"properties":{"avg":{"type":"number"},"max":{"type":"number"},"min":{"type":"number"},"total":{"type":"number"}},"type":"object"}},"components/schemas/QueueActivityStatistics":{"id":"components/schemas/QueueActivityStatistics","kind":"json-schema","title":"QueueActivityStatistics","data":{"properties":{"friendly_name":{"type":"string"},"sid":{"type":"string"},"workers":{"type":"integer"}},"type":"object"}},"components/schemas/TaskQueueData":{"id":"components/schemas/TaskQueueData","kind":"json-schema","title":"TaskQueueData","data":{"properties":{"account_sid":{"type":"string"},"assignment_activity_name":{"nullable":true,"type":"string"},"assignment_activity_sid":{"nullable":true,"type":"string"},"cumulative_statistics":{"properties":{"avg_task_acceptance_time":{"type":"number"},"end_time":{"format":"date-time","type":"string"},"reservations_accepted":{"type":"integer"},"reservations_canceled":{"type":"integer"},"reservations_created":{"type":"integer"},"reservations_rejected":{"type":"integer"},"reservations_rescinded":{"type":"integer"},"reservations_timed_out":{"type":"integer"},"split_by_wait_time":{"$ref":"#/components/schemas/QueueWaitSplitStatistics"},"start_time":{"format":"date-time","type":"string"},"tasks_canceled":{"type":"integer"},"tasks_completed":{"type":"integer"},"tasks_deleted":{"type":"integer"},"tasks_entered":{"type":"integer"},"tasks_moved":{"type":"integer"},"wait_duration_in_queue_until_accepted":{"$ref":"#/components/schemas/QueueWaitDurationStatistics"},"wait_duration_until_accepted":{"$ref":"#/components/schemas/QueueWaitDurationStatistics"},"wait_duration_until_canceled":{"$ref":"#/components/schemas/QueueWaitDurationStatistics"}},"type":"object"},"date_created":{"format":"date-time","type":"string"},"date_updated":{"format":"date-time","type":"string"},"friendly_name":{"type":"string"},"max_reserved_workers":{"type":"integer"},"real_time_statistics":{"properties":{"activity_statistics":{"items":{"$ref":"#/components/schemas/QueueActivityStatistics"},"type":"array"},"longest_relative_task_age_in_queue":{"type":"integer"},"longest_relative_task_sid_in_queue":{"nullable":true,"type":"string"},"longest_task_waiting_age":{"type":"integer"},"longest_task_waiting_sid":{"nullable":true,"type":"string"},"tasks_by_priority":{"type":"object"},"tasks_by_status":{"properties":{"assigned":{"type":"integer"},"canceled":{"type":"integer"},"pending":{"type":"integer"},"reserved":{"type":"integer"},"wrapping":{"type":"integer"}},"type":"object"},"total_available_workers":{"type":"integer"},"total_eligible_workers":{"type":"integer"},"total_tasks":{"type":"integer"}},"type":"object"},"reservation_activity_name":{"nullable":true,"type":"string"},"reservation_activity_sid":{"nullable":true,"type":"string"},"sid":{"nullable":true,"type":"string"},"target_workers":{"nullable":true,"type":"string"},"task_order":{"type":"string"},"workspace_sid":{"type":"string"}},"type":"object"}},"components/schemas/TaskAssignmentStatus":{"id":"components/schemas/TaskAssignmentStatus","kind":"json-schema","title":"TaskAssignmentStatus","data":{"enum":["pending","reserved","assigned","wrapping","completed","canceled"],"type":"string"}},"components/schemas/TaskAttributesBase":{"id":"components/schemas/TaskAttributesBase","kind":"json-schema","title":"TaskAttributesBase","data":{"description":"The attributes of the task. These are the \"content\" of the task, which describe\nthe work to be done.\n","properties":{"task_init_at":{"description":"The date and time the original task was created. This is the time the original task was created, not \nthe time the task was re-created, if it was re-created.\n","type":"string"},"task_lifelong_id":{"description":"A unique identifier for the task that is guaranteed to be the same over the lifetime of the task\nevent if the task is re-created via the \"Unable To Complete\" functionality.\n","type":"string"}},"type":"object"}},"components/schemas/LoanTypesForTask":{"id":"components/schemas/LoanTypesForTask","kind":"json-schema","title":"LoanTypesForTask","data":{"items":{"properties":{"ids":{"example":["LT-AAAA-BBBB"],"items":{"type":"string"},"type":"array"},"names":{"example":["Foobar Installment Loan"],"items":{"type":"string"},"type":"array"},"types":{"items":{"enum":["installment","lineOfCredit"],"type":"string"},"type":"array"}},"type":"object"},"type":"array"}},"components/schemas/BorrowerForTask":{"id":"components/schemas/BorrowerForTask","kind":"json-schema","title":"BorrowerForTask","data":{"description":"The metadata of the borrower about which this task is the subject.\n","properties":{"id":{"description":"The unique identifier for the borrower.\n","example":"BO-AAAA-BBBB","type":"string"},"loanTypes":{"$ref":"#/components/schemas/LoanTypesForTask","description":"Type information about ALL the loans associated with this borrower.\n"},"name":{"description":"The full name of the borrower.\n","type":"string"}},"type":"object"}},"components/schemas/TwilioMinimalInteraction":{"id":"components/schemas/TwilioMinimalInteraction","kind":"json-schema","title":"TwilioMinimalInteraction","data":{"allOf":[{"$ref":"#/components/schemas/BaseTwilioMinimalInteraction"},{"properties":{"previousInteractionSubject":{"$ref":"#/components/schemas/InteractionSubject"},"previousInteractionTheme":{"$ref":"#/components/schemas/InteractionTheme"}},"type":"object"}]}},"components/schemas/TaskAttributesAnswerInboundVoiceCall":{"id":"components/schemas/TaskAttributesAnswerInboundVoiceCall","kind":"json-schema","title":"TaskAttributesAnswerInboundVoiceCall","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"account_sid":{"type":"string"},"api_version":{"type":"string"},"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"call_sid":{"type":"string"},"called":{"type":"string"},"called_city":{"type":"string"},"called_country":{"type":"string"},"called_state":{"type":"string"},"called_zip":{"type":"string"},"caller":{"type":"string"},"caller_city":{"type":"string"},"caller_country":{"type":"string"},"caller_state":{"type":"string"},"caller_zip":{"type":"string"},"case":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"direction":{"type":"string"},"from":{"type":"string"},"from_city":{"type":"string"},"from_country":{"type":"string"},"from_state":{"type":"string"},"from_zip":{"type":"string"},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["answerInboundVoiceCall"],"type":"string"},"to":{"type":"string"},"to_city":{"type":"string"},"to_country":{"type":"string"},"to_state":{"type":"string"},"to_zip":{"type":"string"}},"type":"object"}]}},"components/schemas/CaseForTask":{"id":"components/schemas/CaseForTask","kind":"json-schema","title":"CaseForTask","data":{"description":"The case object associated with this task.\n\nNote that this represents the case data at the moment the task was published,\nif subsequent changes have been made to the case, they will not be reflected here.\n","properties":{"autoCreated":{"type":"boolean"},"borrowerIds":{"items":{"type":"string"},"type":"array"},"caseType":{"$ref":"#/components/schemas/BaseCaseType"},"caseTypeMeta":{"description":"Metadata about the case type object.\n","properties":{"base":{"type":"string"},"derivedFromTypeId":{"nullable":true,"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"version":{"type":"integer"}},"type":"object"},"companyId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"escalatedEmployeeId":{"nullable":true,"type":"string"},"escalatedTeamId":{"description":"The ID of the team to which this case is escalated.","nullable":true,"type":"string"},"escalationIsUrgent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the case is considered \"urgent\" and should be handled with priority."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"id":{"description":"ID of the case.","type":"string"},"loanTypes":{"$ref":"#/components/schemas/LoanTypesForTask","description":"Type information about just the loans associated with this case.\n","nullable":true},"name":{"type":"string"},"outcome":{"$ref":"#/components/schemas/ProcessOutcome"},"owningUserId":{"nullable":true,"type":"string"},"people":{"items":{"type":"string"},"type":"array"},"relatedLoansSummary":{"properties":{"isAnyOverdue":{"type":"boolean"},"maxDaysOverdue":{"type":"integer"},"totalOverdueAmount":{"type":"integer"}},"type":"object"},"status":{"type":"string"},"typeId":{"description":"ID of the case type.","type":"string"}},"type":"object"}},"components/schemas/TaskAttributesHandleInboundInteraction":{"id":"components/schemas/TaskAttributesHandleInboundInteraction","kind":"json-schema","title":"TaskAttributesHandleInboundInteraction","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"$ref":"#/components/schemas/BorrowerForTask"},"case":{"$ref":"#/components/schemas/CaseForTask","nullable":true},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["handleInboundInteraction"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesHandleUnboundInboundInteraction":{"id":"components/schemas/TaskAttributesHandleUnboundInboundInteraction","kind":"json-schema","title":"TaskAttributesHandleUnboundInboundInteraction","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"case":{"$ref":"#/components/schemas/CaseForTask","nullable":true},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["handleUnboundInboundInteraction"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesMakeScheduledCall":{"id":"components/schemas/TaskAttributesMakeScheduledCall","kind":"json-schema","title":"TaskAttributesMakeScheduledCall","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"$ref":"#/components/schemas/BorrowerForTask"},"case":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/CaseForTask"}]},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["makeScheduledCall"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReplyToNewText":{"id":"components/schemas/TaskAttributesReplyToNewText","kind":"json-schema","title":"TaskAttributesReplyToNewText","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["replyToNewText"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReplyToNewWebChat":{"id":"components/schemas/TaskAttributesReplyToNewWebChat","kind":"json-schema","title":"TaskAttributesReplyToNewWebChat","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"$ref":"#/components/schemas/BorrowerForTask"},"case":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["replyToNewWebChat"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReplyToAbandonedWebChat":{"id":"components/schemas/TaskAttributesReplyToAbandonedWebChat","kind":"json-schema","title":"TaskAttributesReplyToAbandonedWebChat","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"$ref":"#/components/schemas/BorrowerForTask"},"case":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/CaseForTask"}]},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["replyToAbandonedWebChat"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewEscalatedCaseAgent":{"id":"components/schemas/TaskAttributesReviewEscalatedCaseAgent","kind":"json-schema","title":"TaskAttributesReviewEscalatedCaseAgent","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewEscalatedCaseAgent"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewEscalatedCaseAgentUrgent":{"id":"components/schemas/TaskAttributesReviewEscalatedCaseAgentUrgent","kind":"json-schema","title":"TaskAttributesReviewEscalatedCaseAgentUrgent","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewEscalatedCaseAgentUrgent"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewEscalatedCaseTeam":{"id":"components/schemas/TaskAttributesReviewEscalatedCaseTeam","kind":"json-schema","title":"TaskAttributesReviewEscalatedCaseTeam","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewEscalatedCaseTeam"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewEscalatedCaseTeamUrgent":{"id":"components/schemas/TaskAttributesReviewEscalatedCaseTeamUrgent","kind":"json-schema","title":"TaskAttributesReviewEscalatedCaseTeamUrgent","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewEscalatedCaseTeamUrgent"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewDocumentUpload":{"id":"components/schemas/TaskAttributesReviewDocumentUpload","kind":"json-schema","title":"TaskAttributesReviewDocumentUpload","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"$ref":"#/components/schemas/BorrowerForTask"},"case":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/CaseForTask"}]},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewDocumentUpload"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewSnoozedCase":{"id":"components/schemas/TaskAttributesReviewSnoozedCase","kind":"json-schema","title":"TaskAttributesReviewSnoozedCase","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewSnoozedCase"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewAutoCreatedCase":{"id":"components/schemas/TaskAttributesReviewAutoCreatedCase","kind":"json-schema","title":"TaskAttributesReviewAutoCreatedCase","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewAutoCreatedCase"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewAutoUpdatedCase":{"id":"components/schemas/TaskAttributesReviewAutoUpdatedCase","kind":"json-schema","title":"TaskAttributesReviewAutoUpdatedCase","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewAutoUpdatedCase"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewCaseInstructions":{"id":"components/schemas/TaskAttributesReviewCaseInstructions","kind":"json-schema","title":"TaskAttributesReviewCaseInstructions","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["reviewCaseInstructions"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesReviewVoicemail":{"id":"components/schemas/TaskAttributesReviewVoicemail","kind":"json-schema","title":"TaskAttributesReviewVoicemail","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"interaction":{"$ref":"#/components/schemas/TwilioMinimalInteraction"},"task_type":{"enum":["reviewVoicemail"],"type":"string"}},"type":"object"}]}},"components/schemas/TaskAttributesSmartReviewCase":{"id":"components/schemas/TaskAttributesSmartReviewCase","kind":"json-schema","title":"TaskAttributesSmartReviewCase","data":{"allOf":[{"$ref":"#/components/schemas/TaskAttributesBase"},{"properties":{"borrower":{"allOf":[{"nullable":true,"type":"object"},{"$ref":"#/components/schemas/BorrowerForTask"}]},"case":{"$ref":"#/components/schemas/CaseForTask"},"interaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"nullable":true,"type":"object"},"task_type":{"enum":["smartReviewCase"],"type":"string"}},"type":"object"}]}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"properties":{"account_sid":{"description":"The unique identifier for the Twilio account.","type":"string"},"addons":{"description":"Currently unused.","type":"string"},"age":{"description":"Time since this task was created in seconds.\n","type":"integer"},"assignment_status":{"$ref":"#/components/schemas/TaskAssignmentStatus"},"attributes":{"oneOf":[{"$ref":"#/components/schemas/TaskAttributesAnswerInboundVoiceCall"},{"$ref":"#/components/schemas/TaskAttributesHandleInboundInteraction"},{"$ref":"#/components/schemas/TaskAttributesHandleUnboundInboundInteraction"},{"$ref":"#/components/schemas/TaskAttributesMakeScheduledCall"},{"$ref":"#/components/schemas/TaskAttributesReplyToNewText"},{"$ref":"#/components/schemas/TaskAttributesReplyToNewWebChat"},{"$ref":"#/components/schemas/TaskAttributesReplyToAbandonedWebChat"},{"$ref":"#/components/schemas/TaskAttributesReviewEscalatedCaseAgent"},{"$ref":"#/components/schemas/TaskAttributesReviewEscalatedCaseAgentUrgent"},{"$ref":"#/components/schemas/TaskAttributesReviewEscalatedCaseTeam"},{"$ref":"#/components/schemas/TaskAttributesReviewEscalatedCaseTeamUrgent"},{"$ref":"#/components/schemas/TaskAttributesReviewDocumentUpload"},{"$ref":"#/components/schemas/TaskAttributesReviewSnoozedCase"},{"$ref":"#/components/schemas/TaskAttributesReviewAutoCreatedCase"},{"$ref":"#/components/schemas/TaskAttributesReviewAutoUpdatedCase"},{"$ref":"#/components/schemas/TaskAttributesReviewCaseInstructions"},{"$ref":"#/components/schemas/TaskAttributesReviewVoicemail"},{"$ref":"#/components/schemas/TaskAttributesSmartReviewCase"}]},"date_created":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the task was created. (Potentially this differs from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_init_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the task's attributes, since when a task is re-created via the \"Unable To Complete\" functionality,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value will be the time the task was re-created.)"},"children":[]}]}]}],"format":"date-time","type":"string"},"date_updated":{"format":"date-time","type":"string"},"priority":{"description":"The priority of the task. A higher priority task jumps the queue ahead of lower priority tasks.\nBy default, tasks have a priority of 0. For example, inbound texts and chats may be configured\nto have a higher priority. And usually, calls will have an even higher priority.\n","type":"integer"},"reason":{"description":"Reason for task cancellation or completion, if applicable.","nullable":true,"type":"string"},"reservation":{"nullable":true,"type":"string"},"sid":{"description":"The unique identifier for the task.","type":"string"},"task_channel_sid":{"description":"The SID of the channel this task is associated with.","type":"string"},"task_channel_unique_name":{"description":"The unique name of the channel this task is associated with.","type":"string"},"task_queue_entered_date":{"description":"The date and time the task entered the queue.","format":"date-time","type":"string"},"task_queue_friendly_name":{"description":"A human-readable name for the task queue.","type":"string"},"task_queue_sid":{"description":"The SID of the queue this task is associated with.","type":"string"},"timeout":{"description":"The timeout value in seconds for task assignment. After this time, the task will be reassigned\nto another agent.\n","type":"integer"},"workflow_friendly_name":{"description":"A human-readable name for the workflow.","type":"string"},"workflow_sid":{"description":"The SID of the workflow this task is associated with.","type":"string"},"workspace_sid":{"description":"The SID of the workspace this task belongs to.","type":"string"}},"type":"object"}},"components/schemas/VersionStatus":{"id":"components/schemas/VersionStatus","kind":"json-schema","title":"VersionStatus","data":{"enum":["draft","active","deprecated"],"type":"string"}},"components/schemas/WorkflowStepType":{"id":"components/schemas/WorkflowStepType","kind":"json-schema","title":"WorkflowStepType","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"additionalProperties":false,"properties":{"companyId":{"description":"The company identifier.","readOnly":true,"type":"string"},"createdBy":{"description":"User identifier who created the workflow step type.","readOnly":true,"type":"string"},"decisionQuestion":{"description":"Decision question is what leads to the \"accepted\" or \"rejected\" outcome\nof the step. This question is displayed to an agent next to the outcome\nof the step. The questions can lead to accept/reject or to yes/no answers.\n","type":"string"},"decisionQuestionType":{"$ref":"#/components/schemas/DecisionQuestionType"},"descriptionLong":{"description":"Additional details on how to complete the step. Normally displayed\nto an agent when clicked on \"more info\" or \"?\" or \"i\" icons.\n","nullable":true,"type":"string"},"descriptionShort":{"description":"A short description of the step. Displayed to agents in the UI.\nCan be a sentence.\n","type":"string"},"mandatory":{"type":"boolean"},"refId":{"description":"The globally unique identifier of the workflow step type.","format":"uuid","type":"string"},"updatedBy":{"description":"User identifier who last updated the workflow step type.","readOnly":true,"type":"string"},"version":{"description":"Version of the workflow step type.","type":"integer"},"versionStatus":{"$ref":"#/components/schemas/VersionStatus"},"visibility":{"$ref":"#/components/schemas/StepVisibility"},"workItems":{"description":"List of work item types that comprise this workflow step type.\n","items":{"description":"Work item type ID.","type":"string"},"type":"array"}},"type":"object"}]}},"components/schemas/WorkflowType":{"id":"components/schemas/WorkflowType","kind":"json-schema","title":"WorkflowType","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"additionalProperties":false,"properties":{"approvalConditions":{"$ref":"#/components/schemas/CaseApprovalConditions"},"companyId":{"description":"The company identifier.","readOnly":true,"type":"string"},"createdBy":{"description":"User identifier who created the workflow type.","readOnly":true,"type":"string"},"description":{"description":"Description of the workflow type. Used internally.","type":"string"},"name":{"description":"A short name of workflow. For example: bankruptcy or identity theft.\n","type":"string"},"refId":{"description":"The globally unique identifier of the workflow type.","format":"uuid","type":"string"},"steps":{"description":"List of step types that comprise a workflow of this type.\n","items":{"description":"Step type ID.","type":"string"},"type":"array"},"updatedBy":{"description":"User identifier who last updated the workflow type.","readOnly":true,"type":"string"},"version":{"description":"Version of the workflow type.","type":"integer"},"versionStatus":{"$ref":"#/components/schemas/VersionStatus"}},"type":"object"}]}},"components/schemas/WorkflowWorkitemType":{"id":"components/schemas/WorkflowWorkitemType","kind":"json-schema","title":"WorkflowWorkitemType","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"additionalProperties":false,"properties":{"companyId":{"description":"The company identifier.","readOnly":true,"type":"string"},"createdBy":{"description":"User identifier who created the workflow item type.","readOnly":true,"type":"string"},"descriptionLong":{"description":"Additional information required to complete the work item.\n","nullable":true,"type":"string"},"descriptionShort":{"description":"A short description of the work item. Displayed to agents in the UI.\nCan be a sentence.\n","type":"string"},"refId":{"description":"The globally unique identifier of the workflow workitem type.","format":"uuid","type":"string"},"updatedBy":{"description":"User identifier who last updated the workflow item type.","readOnly":true,"type":"string"},"version":{"description":"Version of the work item type.","type":"integer"},"versionStatus":{"$ref":"#/components/schemas/VersionStatus"}},"type":"object"}]}},"components/schemas/Code":{"id":"components/schemas/Code","kind":"json-schema","title":"code","data":{"allOf":[{"$ref":"#/components/schemas/VersionedMixin"},{"properties":{"code":{"description":"Base64 of the compiled binary code","nullable":true,"readOnly":true,"type":"string"},"codeText":{"description":"The source code to compile","type":"string"},"compilationVersion":{"description":"The compile version","maxLength":20,"nullable":true,"readOnly":true,"type":"string"},"lastCompiledAt":{"description":"Timestamp of last compile","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"name":{"description":"The name of the code","type":"string"}},"type":"object"}],"title":"code"}},"components/schemas/CodePaging":{"id":"components/schemas/CodePaging","kind":"json-schema","title":"code","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Code"},"type":"array"}},"type":"object"}],"title":"code"}},"components/schemas/CodeExecution":{"id":"components/schemas/CodeExecution","kind":"json-schema","title":"CodeExecution","data":{"description":"Execution of code requires that all arguments to the function be submitted as key-value pairs.\nRunning compiled code will produce a single value output.\n","properties":{"parameters":{"type":"object","writeOnly":true},"result":{"readOnly":true}},"type":"object"}},"components/schemas/DoNotInteractChannel":{"id":"components/schemas/DoNotInteractChannel","kind":"json-schema","title":"DoNotInteractChannel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel(s) for which outbound interactions with a borrower are blocked. Use value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for all channels. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be provided."},"children":[]}]}]}],"enum":["all","voice","email","fax","text","chat","mail"],"type":"string"}},"components/schemas/onCondition":{"id":"components/schemas/onCondition","kind":"json-schema","title":"onCondition","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of conditions for case fields values. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator is used if multiple conditions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are provided. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case has two fields, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chapter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dispositionCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two conditions are created: first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chapter=chapter17"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dispositionCode=dismissed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logical condition will look like: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chapter=chapter17"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dispositionCode=dismissed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"properties":{"dataType":{"$ref":"#/components/schemas/DataType"},"fieldName":{"$ref":"#/components/schemas/FieldName"},"operator":{"default":"eq","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is compared to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using this logical operator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, bankruptcy case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName=chapter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be compared with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value=dismissed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (equal operator)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=equal, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=greater than, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=greater or equal, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=less than, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"le"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=less or equal, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=not equal."},"children":[]}]}]}],"enum":["eq","gt","ge","lt","le","ne"],"type":"string"},"value":{"description":"The value to compare with.\n"}},"type":"object"},"nullable":true,"type":"array"}},"components/schemas/DoNotInteractTheme":{"id":"components/schemas/DoNotInteractTheme","kind":"json-schema","title":"DoNotInteractTheme","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Theme(s) for which outbound interactions with a borrower are blocked. Use value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all themes. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsAccountCredentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to stop debt collection interactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must be provided."},"children":[]}]}]}],"enum":["all","opsCollDebt","opsCollLocateBorrower","opsCollVerifyEmployment","opsCollContactEmployerNotice","opsServicingDebtValidation","opsServicingNegativeCreditReportNotice","opsServicingTimeBarredNotice","opsServicing"],"type":"string"}},"components/schemas/DoNotInteractType":{"id":"components/schemas/DoNotInteractType","kind":"json-schema","title":"doNotInteractHandler","data":{"allOf":[{"$ref":"#/components/schemas/VersionedMixin"},{"properties":{"channel":{"$ref":"#/components/schemas/DoNotInteractChannel","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel(s) for which outbound interactions with a borrower are blocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all channels."},"children":[]}]}]}]},"duration":{"default":0,"description":"Number of days during which the interactions will be blocked.\nWe start counting from the day conditions are met.\n","minimum":0,"nullable":true,"type":"integer"},"object":{"default":"doNotInteractType","enum":["doNotInteractType"],"readOnly":true,"type":"string"},"onCondition":{"$ref":"#/components/schemas/onCondition"},"onOutcome":{"$ref":"#/components/schemas/ProcessOutcome"},"onStatus":{"$ref":"#/components/schemas/ProcessStatus"},"theme":{"$ref":"#/components/schemas/DoNotInteractTheme","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Theme(s) for which outbound interactions with a borrower are blocked. Use value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all themes. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsAccountCredentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to stop debt collection interactions."},"children":[]}]}]}]},"unit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how to count days provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["calendarDays","businessDays"],"nullable":true,"type":"string"}},"type":"object"}],"title":"doNotInteractHandler"}},"components/schemas/DocumentStatus":{"id":"components/schemas/DocumentStatus","kind":"json-schema","title":"DocumentStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document status. The status can be displayed in UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the document was rendered or created but has not accepted or rejected yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the document was determined to be valid and was accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the document was determined to be invalid and was rejected."},"children":[]}]}]}],"enum":["draft","accepted","rejected"],"type":"string"}},"components/schemas/DocumentDescriptorFields":{"id":"components/schemas/DocumentDescriptorFields","kind":"json-schema","title":"DocumentDescriptorFields","data":{"properties":{"archived":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the document has been archived."},"children":[]}]}]}],"type":"boolean"},"autogenerated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this document is generated automatically by a Peach system, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document is created and uploaded manually by a human. If left blank then this value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guessed from the document type."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"contentId":{"description":"The document content identifier. Use this identifier to get the document content.","format":"uuid","readOnly":true,"type":"string"},"contentLength":{"description":"The document content length in bytes.","minimum":0,"readOnly":true,"type":"integer"},"contentType":{"description":"The document content type. For example, PDF or JPEG.","readOnly":true,"type":"string"},"conversionSourceId":{"description":"The original document identifier that was used as a source for conversion to a specific format.","readOnly":true,"type":"string"},"description":{"description":"The description for the document. Normally displayed in UI.","type":"string"},"evidenceId":{"description":"The evidence document identifier. For example: when a borrower enables Autopay, the evidence\ndocument will be the snapshot of UI page.\n","nullable":true,"type":"string"},"fileName":{"description":"The file name of the document. If the document is rendered from a template by the Peach system,\nthe file name will be generated automatically.\nIf the document is created from a file, it will be the name of the file that was uploaded.\nNormally displayed in UI.\n","type":"string"},"isHumanBorrowerUpload":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this document was uploaded by a human borrower--meaning that a borrower (or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"their representative) used a browser to upload this document directly. To put this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"another way, this document was "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uploaded by an agent and was "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uploaded by any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automated system."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"loanId":{"description":"The loan identifier that the documents belongs to.","nullable":true,"type":"string"},"metaData":{"$ref":"#/components/schemas/MetaData"},"personId":{"description":"The borrower's identifier that the documents belongs to.","readOnly":true,"type":"string"},"rejectionReason":{"description":"The reason why the document was rejected. This is a free text. Normally displayed in UI.","type":"string"},"sensitiveData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this flag to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this document has sensitive information, such as PII. The flag is used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proper authorization of access to the information."},"children":[]}]}]}],"type":"boolean"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"templateVersionId":{"description":"Peach internal template identifier that was used to render the document.","nullable":true,"type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user who last updated the document.\nCan be an borrower, agent, or automated system process.\n"},"uploadedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"uploadedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for uploading the document.\nCan be an borrower, agent, or automated system process.\n"},"verifiedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"verifiedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for verifing the document.\nCan be an agent or automated system process.\n"}},"type":"object"}},"components/schemas/DocumentType":{"id":"components/schemas/DocumentType","kind":"json-schema","title":"DocumentType","data":{"description":"The document type.","enum":["loanTermsAgreementOnly","loanTILDisclosureOnly","loanTermsAndTILCombined","loanTermsChangeAgreement","loanAutopayAgreement","loanStatement","loanSettlementAgreement","privacyPolicyLender","privacyPolicyServicer","termsOfServiceLender","termsOfServiceServicer","caseDocument","disclosure","evidence","otherStatement","other"],"type":"string"}},"components/schemas/DocumentDescriptorCreate":{"id":"components/schemas/DocumentDescriptorCreate","kind":"json-schema","title":"DocumentDescriptorCreate","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"$ref":"#/components/schemas/DocumentDescriptorFields"},{"properties":{"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type"],"type":"object"}]}},"components/schemas/DocumentDescriptorResponse":{"id":"components/schemas/DocumentDescriptorResponse","kind":"json-schema","title":"DocumentDescriptorResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"$ref":"#/components/schemas/DocumentDescriptorFields"},{"properties":{"type":{"$ref":"#/components/schemas/DocumentType"}},"type":"object"}]}},"components/schemas/EmployeeBase":{"id":"components/schemas/EmployeeBase","kind":"json-schema","title":"EmployeeBase","data":{"properties":{"firstName":{"description":"The employee's first name.","maxLength":50,"minLength":1,"type":"string"},"lastName":{"description":"The employee's last name.","maxLength":50,"minLength":1,"type":"string"}},"type":"object"}},"components/schemas/Team":{"id":"components/schemas/Team","kind":"json-schema","title":"Team","data":{"description":"A team is a named grouping of Employees","properties":{"email":{"description":"The group email (or listserve) associated with this team.","nullable":true,"type":"string"},"employeeCount":{"description":"The number of employees on this team.","readOnly":true,"type":"integer"},"externalId":{"description":"The lender's external identifier of the team.","nullable":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the team—e.g., \"Engineering\", \"Operations\", \"Customer Support\". Must be unique."},"children":[]}]}]}],"minLength":1,"type":"string"}},"type":"object"}},"components/schemas/Employee":{"id":"components/schemas/Employee","kind":"json-schema","title":"Employee","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/EmployeeBase"},{"description":"An employee in the company","properties":{"assignedInvestorIds":{"description":"The unique identifiers of the investors assigned to the employee.\n","items":{"$ref":"#/components/schemas/AnyId"},"readOnly":true,"type":"array"},"availableAndPermittedTasktypes":{"description":"The Twilio task router task types on which this employee is both permitted and available to work.","items":{"$ref":"#/components/schemas/TaskType"},"readOnly":true,"type":"array"},"companyId":{"description":"The unique company identifier.","readOnly":true,"type":"string"},"displayName":{"description":"The agent's first and last name, if set. Otherwise, their email\naddress.\n","nullable":true,"readOnly":true,"type":"string"},"email":{"description":"The employee's email address.","maxLength":100,"minLength":1,"nullable":true,"type":"string"},"externalId":{"description":"The lender's external identifier for the employee.","nullable":true,"type":"string"},"id":{"description":"A unique identifier for the employee","readOnly":true,"type":"string"},"jobName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of position in the company—e.g., \"CEO\", \"Agent\", \"Supervisor\""},"children":[]}]}]}],"maxLength":100,"minLength":1,"nullable":true,"type":"string"},"managerEmployeeId":{"$ref":"#/components/schemas/AnyId","description":"The ID of the employee's manager","nullable":true},"object":{"default":"Employee","enum":["Employee"],"readOnly":true,"type":"string"},"phone":{"description":"The employee's phone number.","maxLength":16,"minLength":1,"nullable":true,"type":"string"},"teams":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"},"user":{"allOf":[{"$ref":"#/components/schemas/UserBasic"},{"readOnly":true}],"description":"The user associated with this employee"},"userId":{"description":"The ID of the user associated with this employee","type":"string","writeOnly":true}},"type":"object"}]}},"components/schemas/EmailSignatureUpdate":{"id":"components/schemas/EmailSignatureUpdate","kind":"json-schema","title":"EmailSignatureUpdate","data":{"description":"An email signature for an employee","properties":{"contentHtml":{"description":"The HTML email signature content","maxLength":10000,"minLength":0,"nullable":true,"type":"string"},"enabled":{"description":"Whether the email signature is enabled. If true, new emails should include the signature\nwhen drafted.\n","nullable":false,"type":"boolean"}},"type":"object"}},"components/schemas/EmailSignature":{"id":"components/schemas/EmailSignature","kind":"json-schema","title":"EmailSignature","data":{"allOf":[{"$ref":"#/components/schemas/EmailSignatureUpdate"},{"description":"An email signature for an employee","properties":{"contentText":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plain text version of the email signature content. This is generated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentHtml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and cannot be set."},"children":[]}]}]}],"nullable":false,"readOnly":true,"type":"string"},"employeeId":{"description":"The ID of the employee associated with this email signature.","readOnly":true,"type":"string"},"lastUpdatedAt":{"description":"The last time the email signature was updated.","format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"type":"object"}]}},"components/schemas/personId":{"id":"components/schemas/personId","kind":"json-schema","title":"personId","data":{"description":"A Borrower's unique identifier.","type":"string"}},"components/schemas/readOnlyExternalId":{"id":"components/schemas/readOnlyExternalId","kind":"json-schema","title":"readOnlyExternalId","data":{"nullable":true,"readOnly":true,"type":"string"}},"components/schemas/loanId":{"id":"components/schemas/loanId","kind":"json-schema","title":"loanId","data":{"description":"Loan's unique identifier.","type":"string"}},"components/schemas/BaseEvent":{"id":"components/schemas/BaseEvent","kind":"json-schema","title":"BaseEvent","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"companyId":{"description":"Company's unique identifier.","type":"string"},"creatingMessageId":{"description":"The message ID responsible for creating this event.","type":"string"},"discriminator":{"description":"String indicating the type of the parent object.","type":"string"},"effectiveAt":{"description":"The date and time at which the event was effective. This may differ from the date of creation.","format":"date-time","type":"string"},"id":{"description":"Event's unique identifier.","type":"string"},"parentId":{"description":"Unique identifier of the parent object for the event.","type":"string"}},"type":"object"}]}},"components/schemas/LoanEvent":{"id":"components/schemas/LoanEvent","kind":"json-schema","title":"LoanEvent","data":{"allOf":[{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"loanExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"loanId":{"$ref":"#/components/schemas/loanId"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"},{"$ref":"#/components/schemas/BaseEvent"}]}},"components/schemas/condition":{"id":"components/schemas/condition","kind":"json-schema","title":"condition","data":{"enum":["balanceNA","balanceBroken","balanceRed","balanceYellow","balanceGreen"],"type":"string"}},"components/schemas/periodId":{"id":"components/schemas/periodId","kind":"json-schema","title":"periodId","data":{"description":"Period's unique identifier.","type":"string"}},"components/schemas/AutopayPaymentRescheduledEvent":{"id":"components/schemas/AutopayPaymentRescheduledEvent","kind":"json-schema","title":"autopay.payment.rescheduled","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"condition":{"$ref":"#/components/schemas/condition"},"eventType":{"enum":["autopay.payment.rescheduled"],"type":"string"},"periodId":{"$ref":"#/components/schemas/periodId"}},"type":"object"}],"title":"autopay.payment.rescheduled"}},"components/schemas/AutopayPaymentCanceledEvent":{"id":"components/schemas/AutopayPaymentCanceledEvent","kind":"json-schema","title":"autopay.payment.canceled","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"condition":{"$ref":"#/components/schemas/condition"},"eventType":{"enum":["autopay.payment.canceled"],"type":"string"},"periodId":{"$ref":"#/components/schemas/periodId"}},"type":"object"}],"title":"autopay.payment.canceled"}},"components/schemas/autopayCancellationReason":{"id":"components/schemas/autopayCancellationReason","kind":"json-schema","title":"autopayCancellationReason","data":{"enum":["invalidPaymentMethod","paymentMethodRemoved","tooManyFailedAttempts","loanFrozen","loanAccelerated","loanChargedOff","loanPaidOff","canceledByUser","loanTermsChanged"],"type":"string"}},"components/schemas/CancelAutopayScheduleEvent":{"id":"components/schemas/CancelAutopayScheduleEvent","kind":"json-schema","title":"autopay.schedule.cancel","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cancellationReason":{"$ref":"#/components/schemas/autopayCancellationReason"},"eventType":{"enum":["autopay.schedule.cancel"],"type":"string"}},"type":"object"}],"title":"autopay.schedule.cancel"}},"components/schemas/AutopayScheduleChangedEvent":{"id":"components/schemas/AutopayScheduleChangedEvent","kind":"json-schema","title":"autopay.schedule.changed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["autopay.schedule.changed"],"type":"string"}},"type":"object"}],"title":"autopay.schedule.changed"}},"components/schemas/cardId":{"id":"components/schemas/cardId","kind":"json-schema","title":"cardId","data":{"description":"Card's unique identifier.","type":"string"}},"components/schemas/CardReplacementRequestedEvent":{"id":"components/schemas/CardReplacementRequestedEvent","kind":"json-schema","title":"card.replacement.requested","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["card.replacement.requested"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"}},"type":"object"}],"title":"card.replacement.requested"}},"components/schemas/CardCreatedEvent":{"id":"components/schemas/CardCreatedEvent","kind":"json-schema","title":"card.created","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["card.created"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"}},"type":"object"}],"title":"card.created"}},"components/schemas/cardStatus":{"id":"components/schemas/cardStatus","kind":"json-schema","title":"cardStatus","data":{"description":"The status of the card.","enum":["inactive","pendingActivation","pendingFulfillment","active","paused","suspended","terminated","canceled","expired","invalid"],"type":"string"}},"components/schemas/cardStatusChangeReasonCode":{"id":"components/schemas/cardStatusChangeReasonCode","kind":"json-schema","title":"cardStatusChangeReasonCode","data":{"enum":["cardCanceled","cardExpired","cardInvalid","cardClosed","cardDamaged","cardFraudulent","cardInactive","cardLost","cardPFraud","cardSuspended","cardUnauthorized","cardAcceptorActivityQuestionable","cardStolen"],"type":"string"}},"components/schemas/CardStatusChangedEvent":{"id":"components/schemas/CardStatusChangedEvent","kind":"json-schema","title":"card.status.changed","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["card.status.changed"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"newStatus":{"$ref":"#/components/schemas/cardStatus"},"oldStatus":{"$ref":"#/components/schemas/cardStatus"},"statusChangeReasonCode":{"$ref":"#/components/schemas/cardStatusChangeReasonCode"}},"type":"object"}],"title":"card.status.changed"}},"components/schemas/caseId":{"id":"components/schemas/caseId","kind":"json-schema","title":"caseId","data":{"description":"Case's unique identifier.","type":"string"}},"components/schemas/CaseEvent":{"id":"components/schemas/CaseEvent","kind":"json-schema","title":"CaseEvent","data":{"allOf":[{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"caseExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"caseId":{"$ref":"#/components/schemas/caseId"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"},{"$ref":"#/components/schemas/BaseEvent"}]}},"components/schemas/associatedId":{"id":"components/schemas/associatedId","kind":"json-schema","title":"associatedId","data":{"description":"Associated object's unique identifier.","type":"string"}},"components/schemas/associatedObject":{"id":"components/schemas/associatedObject","kind":"json-schema","title":"associatedObject","data":{"description":"Associated object type.","type":"string"}},"components/schemas/CaseAssociationAddedEvent":{"id":"components/schemas/CaseAssociationAddedEvent","kind":"json-schema","title":"case.association.added","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"associatedId":{"$ref":"#/components/schemas/associatedId"},"associatedObject":{"$ref":"#/components/schemas/associatedObject"},"eventType":{"enum":["case.association.added"],"type":"string"}},"type":"object"}],"title":"case.association.added"}},"components/schemas/CaseAssociationRemovedEvent":{"id":"components/schemas/CaseAssociationRemovedEvent","kind":"json-schema","title":"case.association.removed","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"associatedId":{"$ref":"#/components/schemas/associatedId"},"associatedObject":{"$ref":"#/components/schemas/associatedObject"},"eventType":{"enum":["case.association.removed"],"type":"string"}},"type":"object"}],"title":"case.association.removed"}},"components/schemas/CaseDoNotInteractCreatedEvent":{"id":"components/schemas/CaseDoNotInteractCreatedEvent","kind":"json-schema","title":"case.donotinteract.created","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.donotinteract.created"],"type":"string"}},"type":"object"}],"title":"case.donotinteract.created"}},"components/schemas/CaseDoNotInteractDeletedEvent":{"id":"components/schemas/CaseDoNotInteractDeletedEvent","kind":"json-schema","title":"case.donotinteract.deleted","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.donotinteract.deleted"],"type":"string"}},"type":"object"}],"title":"case.donotinteract.deleted"}},"components/schemas/CaseDoNotInteractUpdatedEvent":{"id":"components/schemas/CaseDoNotInteractUpdatedEvent","kind":"json-schema","title":"case.donotinteract.updated","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.donotinteract.updated"],"type":"string"}},"type":"object"}],"title":"case.donotinteract.updated"}},"components/schemas/JSONPatchOpAddReplaceTest":{"id":"components/schemas/JSONPatchOpAddReplaceTest","kind":"json-schema","title":"JSONPatchOpAddReplaceTest","data":{"properties":{"op":{"enum":["add","replace","test"],"type":"string"},"value":{}},"required":["op","value"],"type":"object"}},"components/schemas/JSONPatchOpMoveCopy":{"id":"components/schemas/JSONPatchOpMoveCopy","kind":"json-schema","title":"JSONPatchOpMoveCopy","data":{"properties":{"from":{"type":"string"},"op":{"enum":["move","copy"],"type":"string"}},"required":["op","from"],"type":"object"}},"components/schemas/JSONPatchOpRemove":{"id":"components/schemas/JSONPatchOpRemove","kind":"json-schema","title":"JSONPatchOpRemove","data":{"properties":{"op":{"enum":["remove"],"type":"string"}},"required":["op"],"type":"object"}},"components/schemas/JSONPatchOp":{"id":"components/schemas/JSONPatchOp","kind":"json-schema","title":"JSONPatchOp","data":{"allOf":[{"properties":{"path":{"type":"string"}},"required":["path"],"type":"object"},{"anyOf":[{"$ref":"#/components/schemas/JSONPatchOpAddReplaceTest"},{"$ref":"#/components/schemas/JSONPatchOpMoveCopy"},{"$ref":"#/components/schemas/JSONPatchOpRemove"}]}]}},"components/schemas/ChangeEvent":{"id":"components/schemas/ChangeEvent","kind":"json-schema","title":"ChangeEvent","data":{"allOf":[{"properties":{"changeType":{"enum":["create","update","delete"],"type":"string"},"jsonPatch":{"items":{"$ref":"#/components/schemas/JSONPatchOp"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/BaseEvent"}]}},"components/schemas/CaseDoNotInteractChangedEvent":{"id":"components/schemas/CaseDoNotInteractChangedEvent","kind":"json-schema","title":"case.donotinteract.changed","data":{"allOf":[{"properties":{"caseId":{"$ref":"#/components/schemas/caseId"},"doNotInteractId":{"description":"DNI's unique identifier","type":"string"},"eventType":{"enum":["case.donotinteract.changed"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"case.donotinteract.changed"}},"components/schemas/CaseDoNotInteractExpiredEvent":{"id":"components/schemas/CaseDoNotInteractExpiredEvent","kind":"json-schema","title":"case.donotinteract.expired","data":{"allOf":[{"properties":{"eventType":{"enum":["case.donotinteract.expired"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CaseEvent"}],"title":"case.donotinteract.expired"}},"components/schemas/CaseEscalationChangedEvent":{"id":"components/schemas/CaseEscalationChangedEvent","kind":"json-schema","title":"case.escalation.changed","data":{"allOf":[{"properties":{"caseId":{"$ref":"#/components/schemas/caseId"},"escalationId":{"description":"Escalation's unique identifier","type":"string"},"eventType":{"enum":["case.escalation.changed"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"case.escalation.changed"}},"components/schemas/CaseCreatedEvent":{"id":"components/schemas/CaseCreatedEvent","kind":"json-schema","title":"case.created","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.created"],"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*** DEPRECATED ***"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event is being replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will still appear in API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responses for historical events, but new events will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"title":"case.created"}},"components/schemas/CaseUpdatedEvent":{"id":"components/schemas/CaseUpdatedEvent","kind":"json-schema","title":"case.updated","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.updated"],"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*** DEPRECATED ***"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event is being replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will still appear in API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responses for historical events, but new events will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case.changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"title":"case.updated"}},"components/schemas/CaseDeletedEvent":{"id":"components/schemas/CaseDeletedEvent","kind":"json-schema","title":"case.deleted","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"eventType":{"enum":["case.deleted"],"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*** DEPRECATED ***"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event was never used and will not appear in API requests."},"children":[]}]}]}],"title":"case.deleted"}},"components/schemas/CaseChangedEvent":{"id":"components/schemas/CaseChangedEvent","kind":"json-schema","title":"case.changed","data":{"allOf":[{"properties":{"borrowerId":{"allOf":[{"$ref":"#/components/schemas/personId"}],"description":"The borrower (person) associated with the case. Present on every change type when the case has an associated person; omitted otherwise.\n"},"caseId":{"$ref":"#/components/schemas/caseId"},"eventType":{"enum":["case.changed"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"case.changed"}},"components/schemas/TemplateDescriptorChangedEvent":{"id":"components/schemas/TemplateDescriptorChangedEvent","kind":"json-schema","title":"template.descriptor.changed","data":{"allOf":[{"properties":{"eventType":{"enum":["template.descriptor.changed"],"type":"string"},"templateDescriptorId":{"type":"string"},"userEmail":{"description":"Email of the acting user, snapshotted at event creation time (point-in-time); omitted when unavailable.","nullable":true,"type":"string"},"userId":{"description":"Public id of the user who made the change.","type":"string"},"userName":{"description":"Display name of the acting user, snapshotted onto the event at creation time (point-in-time; not re-resolved from userId).","nullable":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"template.descriptor.changed"}},"components/schemas/TemplateVersionChangedEvent":{"id":"components/schemas/TemplateVersionChangedEvent","kind":"json-schema","title":"template.version.changed","data":{"allOf":[{"properties":{"eventType":{"enum":["template.version.changed"],"type":"string"},"templateDescriptorId":{"type":"string"},"templateVersionId":{"type":"string"},"userEmail":{"description":"Email of the acting user, snapshotted at event creation time (point-in-time); omitted when unavailable.","nullable":true,"type":"string"},"userId":{"description":"Public id of the user who made the change.","type":"string"},"userName":{"description":"Display name of the acting user, snapshotted onto the event at creation time (point-in-time; not re-resolved from userId).","nullable":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"template.version.changed"}},"components/schemas/TemplateVersionActivatedEvent":{"id":"components/schemas/TemplateVersionActivatedEvent","kind":"json-schema","title":"template.version.activated","data":{"allOf":[{"properties":{"eventType":{"enum":["template.version.activated"],"type":"string"},"previousVersionId":{"nullable":true,"type":"string"},"templateDescriptorId":{"type":"string"},"templateVersionId":{"type":"string"},"userEmail":{"description":"Email of the acting user, snapshotted at event creation time (point-in-time); omitted when unavailable.","nullable":true,"type":"string"},"userId":{"description":"Public id of the user who made the change.","type":"string"},"userName":{"description":"Display name of the acting user, snapshotted onto the event at creation time (point-in-time; not re-resolved from userId).","nullable":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseEvent"}],"title":"template.version.activated"}},"components/schemas/contactId":{"id":"components/schemas/contactId","kind":"json-schema","title":"contactId","data":{"description":"Contact's unique identifier.","type":"string"}},"components/schemas/ContactEvent":{"id":"components/schemas/ContactEvent","kind":"json-schema","title":"ContactEvent","data":{"allOf":[{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"contactExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"contactId":{"$ref":"#/components/schemas/contactId"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"},{"$ref":"#/components/schemas/BaseEvent"}]}},"components/schemas/ContactCreatedEvent":{"id":"components/schemas/ContactCreatedEvent","kind":"json-schema","title":"contact.created","data":{"allOf":[{"$ref":"#/components/schemas/ContactEvent"},{"properties":{"eventType":{"enum":["contact.created"],"type":"string"}},"type":"object"}],"title":"contact.created"}},"components/schemas/ContactUpdatedEvent":{"id":"components/schemas/ContactUpdatedEvent","kind":"json-schema","title":"contact.updated","data":{"allOf":[{"$ref":"#/components/schemas/ContactEvent"},{"properties":{"eventType":{"enum":["contact.updated"],"type":"string"}},"type":"object"}],"title":"contact.updated"}},"components/schemas/ContactDeletedEvent":{"id":"components/schemas/ContactDeletedEvent","kind":"json-schema","title":"contact.deleted","data":{"allOf":[{"$ref":"#/components/schemas/ContactEvent"},{"properties":{"eventType":{"enum":["contact.deleted"],"type":"string"}},"type":"object"}],"title":"contact.deleted"}},"components/schemas/InteractionBlockedEvent":{"id":"components/schemas/InteractionBlockedEvent","kind":"json-schema","title":"interaction.blocked","data":{"allOf":[{"$ref":"#/components/schemas/CaseEvent"},{"properties":{"contactExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"contactId":{"$ref":"#/components/schemas/contactId"},"eventType":{"enum":["interaction.blocked"],"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*** DEPRECATED ***"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event was never used and will not appear in API requests."},"children":[]}]}]}],"title":"interaction.blocked"}},"components/schemas/CloseReason":{"id":"components/schemas/CloseReason","kind":"json-schema","title":"CloseReason","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the reason why the account was closed. If passed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locLineClosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" communication template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to phrase the copy as a full sentence or paragraph."},"children":[]}]}]}],"type":"string"}},"components/schemas/CloseReasonDetails":{"id":"components/schemas/CloseReasonDetails","kind":"json-schema","title":"CloseReasonDetails","data":{"default":"other","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the account was closed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedByBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a borrower requested to close the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the account was closed by lender due to inactivity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"terms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the account was closed by lender because it was created with wrong terms or terms changed later (e.g. re-underwriting, charge off, bankruptcy)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"technicalIssue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the account was closed by lender due to a technical issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the account was closed by lender due to fraud."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the account was closed by lender due to a reason not listed above."},"children":[]}]}]}]}],"enum":["requestedByBorrower","inactivity","terms","technicalIssue","fraud","other"],"type":"string"}},"components/schemas/CloseRequestedByBorrower":{"id":"components/schemas/CloseRequestedByBorrower","kind":"json-schema","title":"CloseRequestedByBorrower","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true if a borrower requested to close the account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This attribute has been deprecated, and you should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeReasonDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeRequestedByBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeReasonDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will ignore the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeRequestedByBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeRequestedByBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeReasonDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closeReasonDetails=requestedByBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"nullable":true,"type":"boolean"}},"components/schemas/LoanCloseSendNotice":{"id":"components/schemas/LoanCloseSendNotice","kind":"json-schema","title":"LoanCloseSendNotice","data":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locLineClosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"components/schemas/LoanClosedEvent":{"id":"components/schemas/LoanClosedEvent","kind":"json-schema","title":"loan.closed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"caseId":{"$ref":"#/components/schemas/caseId"},"closeReason":{"$ref":"#/components/schemas/CloseReason"},"closeReasonDetails":{"$ref":"#/components/schemas/CloseReasonDetails"},"closeRequestedByBorrower":{"$ref":"#/components/schemas/CloseRequestedByBorrower"},"eventType":{"enum":["loan.closed"],"type":"string"},"sendNotice":{"$ref":"#/components/schemas/LoanCloseSendNotice"}},"type":"object"}],"title":"loan.closed"}},"components/schemas/LoanCreatedEvent":{"id":"components/schemas/LoanCreatedEvent","kind":"json-schema","title":"loan.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.created"],"type":"string"}},"type":"object"}],"title":"loan.created"}},"components/schemas/CaseId":{"id":"components/schemas/CaseId","kind":"json-schema","title":"CaseId","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"}},"type":"object"}},"components/schemas/LoanCreditLimitChangedEvent":{"id":"components/schemas/LoanCreditLimitChangedEvent","kind":"json-schema","title":"loan.credit.limit.changed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"adverseActionReason":{"description":"The reason why the credit limit was changed.","type":"string"},"creditLimitAmount":{"description":"The new credit limit amount.","type":"number"},"eventType":{"enum":["loan.credit.limit.changed"],"type":"string"},"sendNotice":{"description":"Whether a notice was sent to the borrower","type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"title":"loan.credit.limit.changed"}},"components/schemas/DrawCreditLimitChangedEvent":{"id":"components/schemas/DrawCreditLimitChangedEvent","kind":"json-schema","title":"draw.credit.limit.changed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"creditLimitAmount":{"description":"The new credit limit amount.","type":"number"},"creditLimitPercentage":{"description":"The draw's credit limit as a percentage of the loan's credit limit","type":"number"},"eventType":{"enum":["draw.credit.limit.changed"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"title":"draw.credit.limit.changed"}},"components/schemas/LoanCurrentEvent":{"id":"components/schemas/LoanCurrentEvent","kind":"json-schema","title":"loan.current","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.current"],"type":"string"},"statusChangedDate":{"format":"date","type":"string"}},"type":"object"}],"title":"loan.current"}},"components/schemas/LoanFeeCapitalizedEvent":{"id":"components/schemas/LoanFeeCapitalizedEvent","kind":"json-schema","title":"loan.fee.capitalized","data":{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["loan.fee.capitalized"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"},"feeTypeId":{"$ref":"#/components/schemas/AnyId"},"loanFeeId":{"$ref":"#/components/schemas/AnyId"},"loanId":{"$ref":"#/components/schemas/loanId"}},"title":"loan.fee.capitalized","type":"object"}},"components/schemas/LoanOverdueEvent":{"id":"components/schemas/LoanOverdueEvent","kind":"json-schema","title":"loan.overdue","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.overdue"],"type":"string"},"overdueNumberDays":{"type":"number"},"overdueTotalAmount":{"format":"float","type":"number"},"statusChangedDate":{"format":"date","type":"string"}},"type":"object"}],"title":"loan.overdue"}},"components/schemas/LoanOverdueUpdateEvent":{"id":"components/schemas/LoanOverdueUpdateEvent","kind":"json-schema","title":"loan.overdue.update","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.overdue.update"],"type":"string"},"overdueNumberDays":{"type":"number"},"overdueTotalAmount":{"format":"float","type":"number"},"statusChangedDate":{"format":"date","type":"string"}},"type":"object"}],"title":"loan.overdue.update"}},"components/schemas/LoanLateFeeBookedEvent":{"id":"components/schemas/LoanLateFeeBookedEvent","kind":"json-schema","title":"loan.latefee.booked","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.latefee.booked"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.latefee.booked"}},"components/schemas/LoanMigrationSucceededEvent":{"id":"components/schemas/LoanMigrationSucceededEvent","kind":"json-schema","title":"loan.migration.succeeded","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.migration.succeeded"],"type":"string"},"migrationEventCreatingMessageId":{"type":"string"}},"type":"object"}],"title":"loan.migration.succeeded"}},"components/schemas/LoanMigrationFailedEvent":{"id":"components/schemas/LoanMigrationFailedEvent","kind":"json-schema","title":"loan.migration.failed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.migration.failed"],"type":"string"},"migrationEventCreatingMessageId":{"type":"string"}},"type":"object"}],"title":"loan.migration.failed"}},"components/schemas/LoanModificationFeeBookedEvent":{"id":"components/schemas/LoanModificationFeeBookedEvent","kind":"json-schema","title":"loan.modificationfee.booked","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.modificationfee.booked"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.modificationfee.booked"}},"components/schemas/LoanFeeBooked":{"id":"components/schemas/LoanFeeBooked","kind":"json-schema","title":"loan.fee.booked","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.fee.booked"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"},"feeType":{"enum":["foreignTransactionFee","lateFee","modificationFee","purchaseFee","nsfFee","serviceFee"],"type":"string"}},"type":"object"}],"title":"loan.fee.booked"}},"components/schemas/LoanFeeCanceledEvent":{"id":"components/schemas/LoanFeeCanceledEvent","kind":"json-schema","title":"loan.fee.canceled","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"caseId":{"$ref":"#/components/schemas/CaseId"},"eventType":{"enum":["loan.fee.canceled"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"},"feeChargedAt":{"format":"date-time","type":"string"},"feeTypeId":{"$ref":"#/components/schemas/AnyId"},"loanFeeId":{"$ref":"#/components/schemas/AnyId"},"lockId":{"nullable":true,"type":"string"}},"type":"object"}],"title":"loan.fee.canceled"}},"components/schemas/LoanFeeChangedEvent":{"id":"components/schemas/LoanFeeChangedEvent","kind":"json-schema","title":"loan.fee.changed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"caseId":{"$ref":"#/components/schemas/CaseId"},"eventType":{"enum":["loan.fee.changed"],"type":"string"},"expectedBalanceImpact":{"enum":["increase","decrease","unknown"],"type":"string"},"expectedPaymentId":{"$ref":"#/components/schemas/AnyId"},"feeChargedAt":{"format":"date-time","type":"string"},"feeTypeId":{"$ref":"#/components/schemas/AnyId"},"loanFeeId":{"$ref":"#/components/schemas/AnyId"},"lockId":{"nullable":true,"type":"string"},"newAmount":{"nullable":true,"type":"number"},"oldAmount":{"type":"number"}},"type":"object"}],"title":"loan.fee.changed"}},"components/schemas/LoanOwnerChangedEvent":{"id":"components/schemas/LoanOwnerChangedEvent","kind":"json-schema","title":"loan.ownerchanged","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.ownerchanged"],"type":"string"}},"type":"object"}],"title":"loan.ownerchanged"}},"components/schemas/drawId":{"id":"components/schemas/drawId","kind":"json-schema","title":"drawId","data":{"description":"Draw's unique identifier.","type":"string"}},"components/schemas/RemainingBalancesDeferredEvent":{"id":"components/schemas/RemainingBalancesDeferredEvent","kind":"json-schema","title":"loan.remainingbalances.deferred","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"capitalizedBeforeDeferral":{"additionalProperties":{"type":"string"},"description":"Per obligation, the amount that was already capitalized on it before this deferral ran, keyed by obligation ID. Used to re-derive the deferral if the loan is replayed.","nullable":true,"type":"object"},"deferralType":{"enum":["capitalizeRemainingBalance"],"nullable":false,"type":"string"},"drawIds":{"items":{"$ref":"#/components/schemas/drawId"},"type":"array"},"dueDates":{"items":{"format":"date","type":"string"},"type":"array"},"eventType":{"enum":["loan.remainingbalances.deferred"],"type":"string"},"totalDeferredAmount":{"format":"float","type":"number"}},"type":"object"}],"title":"loan.remainingbalances.deferred"}},"components/schemas/LoanPromoProgramActivatedEvent":{"id":"components/schemas/LoanPromoProgramActivatedEvent","kind":"json-schema","title":"loan.promoprogram.activated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.activated"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.activated"}},"components/schemas/LoanPromoProgramCanceledEvent":{"id":"components/schemas/LoanPromoProgramCanceledEvent","kind":"json-schema","title":"loan.promoprogram.canceled","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.canceled"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.canceled"}},"components/schemas/LoanPromoProgramCreatedEvent":{"id":"components/schemas/LoanPromoProgramCreatedEvent","kind":"json-schema","title":"loan.promoprogram.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.created"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.created"}},"components/schemas/LoanPromoProgramExercisedEvent":{"id":"components/schemas/LoanPromoProgramExercisedEvent","kind":"json-schema","title":"loan.promoprogram.exercised","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.exercised"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.exercised"}},"components/schemas/LoanPromoProgramReactivatedEvent":{"id":"components/schemas/LoanPromoProgramReactivatedEvent","kind":"json-schema","title":"loan.promoprogram.reactivated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.reactivated"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.reactivated"}},"components/schemas/LoanPromoProgramUpdatedEvent":{"id":"components/schemas/LoanPromoProgramUpdatedEvent","kind":"json-schema","title":"loan.promoprogram.updated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.promoprogram.updated"],"type":"string"},"promoId":{"$ref":"#/components/schemas/AnyId"}},"type":"object"}],"title":"loan.promoprogram.updated"}},"components/schemas/LoanRateCreatedEvent":{"id":"components/schemas/LoanRateCreatedEvent","kind":"json-schema","title":"loan.rate.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.rate.created"],"type":"string"}},"type":"object"}],"title":"loan.rate.created"}},"components/schemas/LoanRateUpdatedEvent":{"id":"components/schemas/LoanRateUpdatedEvent","kind":"json-schema","title":"loan.rate.updated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.rate.updated"],"type":"string"}},"type":"object"}],"title":"loan.rate.updated"}},"components/schemas/LoanRefundedEvent":{"id":"components/schemas/LoanRefundedEvent","kind":"json-schema","title":"loan.refunded","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.refunded"],"type":"string"}},"type":"object"}],"title":"loan.refunded"}},"components/schemas/loanTypeId":{"id":"components/schemas/loanTypeId","kind":"json-schema","title":"loanTypeId","data":{"description":"Loan type's unique identifier.","type":"string"}},"components/schemas/refundId":{"id":"components/schemas/refundId","kind":"json-schema","title":"refundId","data":{"description":"Refund's unique identifier.","type":"string"}},"components/schemas/InstallmentRefundedEvent":{"id":"components/schemas/InstallmentRefundedEvent","kind":"json-schema","title":"installment.refunded","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"atFaultParty":{"type":"string"},"caseId":{"$ref":"#/components/schemas/caseId"},"eventType":{"enum":["installment.refunded"],"type":"string"},"isFullRefund":{"type":"boolean"},"isSendNotice":{"type":"boolean"},"loanDownPaymentAmount":{"description":"Serialized as a decimal string.","type":"string"},"loanTypeId":{"$ref":"#/components/schemas/loanTypeId"},"refundAmount":{"type":"number"},"refundId":{"$ref":"#/components/schemas/refundId"}},"type":"object"}],"title":"installment.refunded"}},"components/schemas/LoanReimbursementInitiatedEvent":{"id":"components/schemas/LoanReimbursementInitiatedEvent","kind":"json-schema","title":"loan.reimbursement.initiated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.reimbursement.initiated"],"type":"string"}},"type":"object"}],"title":"loan.reimbursement.initiated"}},"components/schemas/LoanReimbursementProcessedEvent":{"id":"components/schemas/LoanReimbursementProcessedEvent","kind":"json-schema","title":"loan.reimbursement.processed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.reimbursement.processed"],"type":"string"}},"type":"object"}],"title":"loan.reimbursement.processed"}},"components/schemas/LoanStatusChangedEvent":{"id":"components/schemas/LoanStatusChangedEvent","kind":"json-schema","title":"loan.statuschanged","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.statuschanged"],"type":"string"},"newStatus":{"$ref":"#/components/schemas/LoanStatus"},"oldStatus":{"$ref":"#/components/schemas/LoanStatus"}},"type":"object"}],"title":"loan.statuschanged"}},"components/schemas/PeriodStartedEvent":{"id":"components/schemas/PeriodStartedEvent","kind":"json-schema","title":"loan.period.started","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"dueDate":{"description":"The due date associated with the period.","format":"date-time","type":"string"},"eventType":{"enum":["loan.period.started"],"type":"string"},"periodId":{"$ref":"#/components/schemas/periodId"}},"required":["dueDate"],"type":"object"}],"title":"loan.period.started"}},"components/schemas/ObligationStatusChangedEvent":{"id":"components/schemas/ObligationStatusChangedEvent","kind":"json-schema","title":"loan.obligation.statuschanged","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"eventType":{"enum":["loan.obligation.statuschanged"],"type":"string"},"isOverdue":{"description":"The new obligation status to be recorded\n","type":"boolean"}},"required":["isOverdue"],"type":"object"}],"title":"loan.obligation.statuschanged"}},"components/schemas/previousInteractionId":{"id":"components/schemas/previousInteractionId","kind":"json-schema","title":"previousInteractionId","data":{"description":"If a previous interaction identifier is provided, the current and previous interactions will be linked. This can either be Peach's or a lender's external identifier.","nullable":true,"type":"string"}},"components/schemas/supercaseBulkOperationId":{"id":"components/schemas/supercaseBulkOperationId","kind":"json-schema","title":"supercaseBulkOperationId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SupercaseBulkOperation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created this event, this is that ID"},"children":[]}]}]}],"nullable":true,"type":"string"}},"components/schemas/SendCommunicationEvent":{"id":"components/schemas/SendCommunicationEvent","kind":"json-schema","title":"communication.send","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"attachments":{"description":"An optional list of documents to attach to the outgoing email.\n","items":{"description":"A document descriptor ID.","type":"string"},"type":"array"},"caseId":{"$ref":"#/components/schemas/caseId"},"channel":{"$ref":"#/components/schemas/InteractionChannel"},"contactId":{"$ref":"#/components/schemas/contactId"},"context":{"description":"Additional context to be passed when creating a message from preset templates for communication\n","type":"object"},"eventType":{"enum":["communication.send"],"type":"string"},"isTransactional":{"default":true,"type":"boolean"},"loanId":{"$ref":"#/components/schemas/loanId"},"loanIds":{"items":{"type":"string"},"type":"array"},"personId":{"$ref":"#/components/schemas/personId"},"previousInteractionId":{"$ref":"#/components/schemas/previousInteractionId"},"subject":{"$ref":"#/components/schemas/InteractionSubject"},"supercaseBulkOperationId":{"$ref":"#/components/schemas/supercaseBulkOperationId"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"required":["subject","personId"],"type":"object"}],"title":"communication.send"}},"components/schemas/statementId":{"id":"components/schemas/statementId","kind":"json-schema","title":"statementId","data":{"description":"Statement's unique identifier.","type":"string"}},"components/schemas/StatementCreatedEvent":{"id":"components/schemas/StatementCreatedEvent","kind":"json-schema","title":"statement.created","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"eventType":{"enum":["statement.created"],"type":"string"},"loanExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"loanId":{"$ref":"#/components/schemas/loanId"},"periodId":{"$ref":"#/components/schemas/periodId"},"statementId":{"$ref":"#/components/schemas/statementId"}},"type":"object"}],"title":"statement.created"}},"components/schemas/ownerId":{"id":"components/schemas/ownerId","kind":"json-schema","title":"ownerId","data":{"description":"Payment instrument owner's unique identifier. Currently, the owner can be a borrower, investor, broker or payment processor.","type":"string"}},"components/schemas/ownerType":{"id":"components/schemas/ownerType","kind":"json-schema","title":"ownerType","data":{"description":"Type of owner of the payment instrument.","enum":["person","investor","broker","paymentProcessor"],"type":"string"}},"components/schemas/paymentInstrumentId":{"id":"components/schemas/paymentInstrumentId","kind":"json-schema","title":"paymentInstrumentId","data":{"description":"Payment Instrument's unique identifier.","type":"string"}},"components/schemas/PaymentInstrumentCreatedEvent":{"id":"components/schemas/PaymentInstrumentCreatedEvent","kind":"json-schema","title":"payment.instrument.created","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId","nullable":true},"eventType":{"enum":["payment.instrument.created"],"type":"string"},"ownerId":{"$ref":"#/components/schemas/ownerId"},"ownerType":{"$ref":"#/components/schemas/ownerType"},"paymentInstrumentExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"paymentInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"payment.instrument.created"}},"components/schemas/PaymentInstrumentUpdatedEvent":{"id":"components/schemas/PaymentInstrumentUpdatedEvent","kind":"json-schema","title":"payment.instrument.updated","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId","nullable":true},"changes":{"type":"object"},"eventType":{"enum":["payment.instrument.updated"],"type":"string"},"ownerId":{"$ref":"#/components/schemas/ownerId"},"ownerType":{"$ref":"#/components/schemas/ownerType"},"paymentInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"}},"type":"object"}],"title":"payment.instrument.updated"}},"components/schemas/PaymentInstrumentDeactivatedEvent":{"id":"components/schemas/PaymentInstrumentDeactivatedEvent","kind":"json-schema","title":"payment.instrument.deactivated","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId","nullable":true},"eventType":{"enum":["payment.instrument.deactivated"],"type":"string"},"ownerId":{"$ref":"#/components/schemas/ownerId"},"ownerType":{"$ref":"#/components/schemas/ownerType"},"paymentInstrumentExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"paymentInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"payment.instrument.deactivated"}},"components/schemas/PersonBankruptcyDeceasedStartMonitoringEvent":{"id":"components/schemas/PersonBankruptcyDeceasedStartMonitoringEvent","kind":"json-schema","title":"person.monitoring.bankruptcy.started","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["person.monitoring.bankruptcy.started"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"person.monitoring.bankruptcy.started"}},"components/schemas/consentId":{"id":"components/schemas/consentId","kind":"json-schema","title":"consentId","data":{"description":"Consent's unique identifier.","type":"string"}},"components/schemas/PersonConsentUpdatedEvent":{"id":"components/schemas/PersonConsentUpdatedEvent","kind":"json-schema","title":"person.consent.updated","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"consentId":{"$ref":"#/components/schemas/consentId"},"eventType":{"enum":["person.consent.updated"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"person.consent.updated"}},"components/schemas/PersonCreatedEvent":{"id":"components/schemas/PersonCreatedEvent","kind":"json-schema","title":"person.created","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["person.created"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"person.created"}},"components/schemas/PersonSCRAStartMonitoringEvent":{"id":"components/schemas/PersonSCRAStartMonitoringEvent","kind":"json-schema","title":"person.monitoring.scra.start","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["person.monitoring.scra.start"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"}},"type":"object"}],"title":"person.monitoring.scra.start"}},"components/schemas/transactionId":{"id":"components/schemas/transactionId","kind":"json-schema","title":"transactionId","data":{"description":"Transaction's unique identifier.","type":"string"}},"components/schemas/PaymentChargebackEvent":{"id":"components/schemas/PaymentChargebackEvent","kind":"json-schema","title":"payment.chargeback","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"amount":{"description":"The amount of the chargeback","type":"number"},"borrowerId":{"$ref":"#/components/schemas/personId"},"description":{"description":"The description of the chargeback","type":"string"},"eventType":{"enum":["payment.chargeback"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"reasonCode":{"description":"The reason code","type":"string"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.chargeback"}},"components/schemas/PaymentChargebackReversedEvent":{"id":"components/schemas/PaymentChargebackReversedEvent","kind":"json-schema","title":"payment.chargeback.reversed","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"amount":{"description":"The amount of the chargeback","type":"number"},"borrowerId":{"$ref":"#/components/schemas/personId"},"description":{"description":"The description of the chargeback","type":"string"},"eventType":{"enum":["payment.chargeback.reversed"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"reasonCode":{"description":"The reason code","type":"string"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.chargeback.reversed"}},"components/schemas/PaymentFailedEvent":{"id":"components/schemas/PaymentFailedEvent","kind":"json-schema","title":"payment.failed","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"eventType":{"enum":["payment.failed"],"type":"string"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.failed"}},"components/schemas/PaymentInitiatedEvent":{"id":"components/schemas/PaymentInitiatedEvent","kind":"json-schema","title":"payment.initiated","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.initiated"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.initiated"}},"components/schemas/PaymentPendingEvent":{"id":"components/schemas/PaymentPendingEvent","kind":"json-schema","title":"payment.pending","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.pending"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.pending"}},"components/schemas/PaymentReversedEvent":{"id":"components/schemas/PaymentReversedEvent","kind":"json-schema","title":"payment.reversed","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"amount":{"description":"The amount of the reversal","type":"number"},"borrowerExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.reversed"],"type":"string"},"reversedAmount":{"description":"The sum of all of the reversals of the original transaction.","type":"number"},"reversedTransactionId":{"description":"Unique identifier of the original transaction.","type":"string"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.reversed"}},"components/schemas/PaymentScheduledEvent":{"id":"components/schemas/PaymentScheduledEvent","kind":"json-schema","title":"payment.scheduled","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.scheduled"],"type":"string"},"personExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.scheduled"}},"components/schemas/PaymentSucceededEvent":{"id":"components/schemas/PaymentSucceededEvent","kind":"json-schema","title":"payment.succeeded","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.succeeded"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"paymentInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.succeeded"}},"components/schemas/newScheduledDate":{"id":"components/schemas/newScheduledDate","kind":"json-schema","title":"newScheduledDate","data":{"format":"date","type":"string"}},"components/schemas/oldScheduledDate":{"id":"components/schemas/oldScheduledDate","kind":"json-schema","title":"oldScheduledDate","data":{"format":"date","type":"string"}},"components/schemas/PaymentRescheduledEvent":{"id":"components/schemas/PaymentRescheduledEvent","kind":"json-schema","title":"payment.rescheduled","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.rescheduled"],"type":"string"},"loanExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"loanId":{"$ref":"#/components/schemas/loanId"},"newScheduledDate":{"$ref":"#/components/schemas/newScheduledDate"},"oldScheduledDate":{"$ref":"#/components/schemas/oldScheduledDate"},"transactionExternalId":{"$ref":"#/components/schemas/readOnlyExternalId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.rescheduled"}},"components/schemas/paymentInstrumentType":{"id":"components/schemas/paymentInstrumentType","kind":"json-schema","title":"paymentInstrumentType","data":{"enum":["bankAccount"],"type":"string"}},"components/schemas/transactionCreatedAt":{"id":"components/schemas/transactionCreatedAt","kind":"json-schema","title":"transactionCreatedAt","data":{"format":"date-time","type":"string"}},"components/schemas/transactionCurrency":{"id":"components/schemas/transactionCurrency","kind":"json-schema","title":"transactionCurrency","data":{"pattern":"[A-Z]{3}","type":"string"}},"components/schemas/transactionIsExternal":{"id":"components/schemas/transactionIsExternal","kind":"json-schema","title":"transactionIsExternal","data":{"type":"boolean"}},"components/schemas/transactionScheduledAmount":{"id":"components/schemas/transactionScheduledAmount","kind":"json-schema","title":"transactionScheduledAmount","data":{"type":"number"}},"components/schemas/transactionScheduledDate":{"id":"components/schemas/transactionScheduledDate","kind":"json-schema","title":"transactionScheduledDate","data":{"format":"date","type":"string"}},"components/schemas/PaymentDueTodayEvent":{"id":"components/schemas/PaymentDueTodayEvent","kind":"json-schema","title":"payment.due.today","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.due.today"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"paymentInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"paymentInstrumentType":{"$ref":"#/components/schemas/paymentInstrumentType"},"transactionCreatedAt":{"$ref":"#/components/schemas/transactionCreatedAt"},"transactionCurrency":{"$ref":"#/components/schemas/transactionCurrency"},"transactionId":{"$ref":"#/components/schemas/transactionId"},"transactionIsExternal":{"$ref":"#/components/schemas/transactionIsExternal"},"transactionScheduledAmount":{"$ref":"#/components/schemas/transactionScheduledAmount"},"transactionScheduledDate":{"$ref":"#/components/schemas/transactionScheduledDate"}},"type":"object"}],"title":"payment.due.today"}},"components/schemas/PaymentHoldDaysExpiredEvent":{"id":"components/schemas/PaymentHoldDaysExpiredEvent","kind":"json-schema","title":"payment.hold.days.expired","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["payment.hold.days.expired"],"type":"string"},"loanId":{"$ref":"#/components/schemas/loanId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"payment.hold.days.expired"}},"components/schemas/purchaseId":{"id":"components/schemas/purchaseId","kind":"json-schema","title":"purchaseId","data":{"description":"Purchase's unique identifier.","type":"string"}},"components/schemas/PurchaseAuthorizedEvent":{"id":"components/schemas/PurchaseAuthorizedEvent","kind":"json-schema","title":"purchase.authorized","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["purchase.authorized"],"type":"string"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"}},"type":"object"}],"title":"purchase.authorized"}},"components/schemas/PurchaseSettledEvent":{"id":"components/schemas/PurchaseSettledEvent","kind":"json-schema","title":"purchase.settled","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["purchase.settled"],"type":"string"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"}},"type":"object"}],"title":"purchase.settled"}},"components/schemas/PurchaseAppliedEvent":{"id":"components/schemas/PurchaseAppliedEvent","kind":"json-schema","title":"purchase.applied","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["purchase.applied"],"type":"string"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"}},"type":"object"}],"title":"purchase.applied"}},"components/schemas/lineOfCreditId":{"id":"components/schemas/lineOfCreditId","kind":"json-schema","title":"lineOfCreditId","data":{"description":"Line of Credit's unique identifier.","type":"string"}},"components/schemas/PurchaseCreatedEvent":{"id":"components/schemas/PurchaseCreatedEvent","kind":"json-schema","title":"purchase.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["purchase.created"],"type":"string"},"lineOfCreditId":{"$ref":"#/components/schemas/lineOfCreditId"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"}},"type":"object"}],"title":"purchase.created"}},"components/schemas/newAmount":{"id":"components/schemas/newAmount","kind":"json-schema","title":"newAmount","data":{"type":"number"}},"components/schemas/newStatus":{"id":"components/schemas/newStatus","kind":"json-schema","title":"newStatus","data":{"type":"string"}},"components/schemas/oldAmount":{"id":"components/schemas/oldAmount","kind":"json-schema","title":"oldAmount","data":{"type":"number"}},"components/schemas/oldStatus":{"id":"components/schemas/oldStatus","kind":"json-schema","title":"oldStatus","data":{"type":"string"}},"components/schemas/PurchaseChangedEvent":{"id":"components/schemas/PurchaseChangedEvent","kind":"json-schema","title":"purchase.changed","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"eventType":{"enum":["purchase.changed"],"type":"string"},"lineOfCreditId":{"$ref":"#/components/schemas/lineOfCreditId"},"newAmount":{"$ref":"#/components/schemas/newAmount"},"newStatus":{"$ref":"#/components/schemas/newStatus"},"oldAmount":{"$ref":"#/components/schemas/oldAmount"},"oldStatus":{"$ref":"#/components/schemas/oldStatus"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"}},"type":"object"}],"title":"purchase.changed"}},"components/schemas/purchaseDisputeId":{"id":"components/schemas/purchaseDisputeId","kind":"json-schema","title":"purchaseDisputeId","data":{"description":"Purchase dispute's unique identifier.","type":"string"}},"components/schemas/purchaseDisputeStatus":{"id":"components/schemas/purchaseDisputeStatus","kind":"json-schema","title":"purchaseDisputeStatus","data":{"enum":["unsubmitted","submitted","expired","won","lost","canceled"],"type":"string"}},"components/schemas/PurchaseDisputeCreatedEvent":{"id":"components/schemas/PurchaseDisputeCreatedEvent","kind":"json-schema","title":"purchase.dispute.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"drawId":{"$ref":"#/components/schemas/drawId"},"eventType":{"enum":["purchase.dispute.created"],"type":"string"},"isPastPurchaseDispute":{"description":"Whether the purchase dispute is for a past purchase or not. Past purchases are used in LOC migrations. Past purchases have effective dates before the migration cutoff date.","type":"boolean"},"purchaseDisputeId":{"$ref":"#/components/schemas/purchaseDisputeId"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"},"status":{"$ref":"#/components/schemas/purchaseDisputeStatus"}},"type":"object"}],"title":"purchase.dispute.created"}},"components/schemas/PurchaseDisputeUpdatedEvent":{"id":"components/schemas/PurchaseDisputeUpdatedEvent","kind":"json-schema","title":"purchase.dispute.updated","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"cardId":{"$ref":"#/components/schemas/cardId"},"drawId":{"$ref":"#/components/schemas/drawId"},"eventType":{"enum":["purchase.dispute.updated"],"type":"string"},"isPastPurchaseDispute":{"description":"Whether the purchase dispute is for a past purchase or not. Past purchases are used in LOC migrations. Past purchases have effective dates before the migration cutoff date.","type":"boolean"},"purchaseDisputeId":{"$ref":"#/components/schemas/purchaseDisputeId"},"purchaseId":{"$ref":"#/components/schemas/purchaseId"},"status":{"$ref":"#/components/schemas/purchaseDisputeStatus"}},"type":"object"}],"title":"purchase.dispute.updated"}},"components/schemas/creditAgencyId":{"id":"components/schemas/creditAgencyId","kind":"json-schema","title":"creditAgencyId","data":{"description":"Credit agency's unique identifier.","format":"date","type":"string"}},"components/schemas/startDate":{"id":"components/schemas/startDate","kind":"json-schema","title":"startDate","data":{"format":"date","type":"string"}},"components/schemas/LoanCreditReportingCreatedEvent":{"id":"components/schemas/LoanCreditReportingCreatedEvent","kind":"json-schema","title":"loan.creditreporting.created","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"creditAgencyId":{"$ref":"#/components/schemas/creditAgencyId"},"eventType":{"enum":["loan.creditreporting.created"],"type":"string"},"startDate":{"$ref":"#/components/schemas/startDate"}},"type":"object"}],"title":"loan.creditreporting.created"}},"components/schemas/stopDate":{"id":"components/schemas/stopDate","kind":"json-schema","title":"stopDate","data":{"format":"date","type":"string"}},"components/schemas/LoanCreditReportingStoppedEvent":{"id":"components/schemas/LoanCreditReportingStoppedEvent","kind":"json-schema","title":"loan.creditreporting.stopped","data":{"allOf":[{"$ref":"#/components/schemas/LoanEvent"},{"properties":{"caseId":{"$ref":"#/components/schemas/caseId"},"creditAgencyId":{"$ref":"#/components/schemas/creditAgencyId"},"eventType":{"enum":["loan.creditreporting.stopped"],"type":"string"},"stopDate":{"$ref":"#/components/schemas/stopDate"}},"type":"object"}],"title":"loan.creditreporting.stopped"}},"components/schemas/obligationId":{"id":"components/schemas/obligationId","kind":"json-schema","title":"obligationId","data":{"description":"Obligation unique identifier.","type":"string"}},"components/schemas/InterestCapitalizedEvent":{"id":"components/schemas/InterestCapitalizedEvent","kind":"json-schema","title":"loan.interest.capitalized","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"borrowerId":{"$ref":"#/components/schemas/personId"},"eventType":{"enum":["loan.interest.capitalized"],"type":"string"},"feeAmount":{"description":"The fee amount capitalized.","type":"number"},"interestAmount":{"description":"The interest amount capitalized.","type":"number"},"isReplay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if capitalization was updated after the overdue date."},"children":[]}]}]}],"type":"boolean"},"loanId":{"$ref":"#/components/schemas/loanId"},"obligationId":{"$ref":"#/components/schemas/obligationId"}},"type":"object"}],"title":"loan.interest.capitalized"}},"components/schemas/achFileId":{"id":"components/schemas/achFileId","kind":"json-schema","title":"achFileId","data":{"description":"The ACH File upload monitoring record ID.","nullable":true,"type":"string"}},"components/schemas/paymentProcessorId":{"id":"components/schemas/paymentProcessorId","kind":"json-schema","title":"paymentProcessorId","data":{"description":"The payment processor ID.","type":"string"}},"components/schemas/ACHFileEvent":{"id":"components/schemas/ACHFileEvent","kind":"json-schema","title":"ACHFileEvent","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"achFileId":{"$ref":"#/components/schemas/achFileId"},"fileName":{"$ref":"#/components/schemas/fileName"},"processorId":{"$ref":"#/components/schemas/paymentProcessorId"}},"required":["processorId","fileName"],"type":"object"}]}},"components/schemas/ACHFileCreatedEvent":{"id":"components/schemas/ACHFileCreatedEvent","kind":"json-schema","title":"ach.file.created","data":{"allOf":[{"$ref":"#/components/schemas/ACHFileEvent"},{"properties":{"eventType":{"enum":["ach.file.created"],"type":"string"}},"type":"object"}],"title":"ach.file.created"}},"components/schemas/fileDestination":{"id":"components/schemas/fileDestination","kind":"json-schema","title":"fileDestination","data":{"description":"The destination where we are going to store the ACH File.","enum":["gcp","sftp"],"type":"string"}},"components/schemas/ACHFileUploadEvent":{"id":"components/schemas/ACHFileUploadEvent","kind":"json-schema","title":"ACHFileUploadEvent","data":{"allOf":[{"$ref":"#/components/schemas/ACHFileEvent"},{"properties":{"fileDestination":{"$ref":"#/components/schemas/fileDestination"}},"required":["fileDestination"],"type":"object"}]}},"components/schemas/ACHFileUploadAttemptedEvent":{"id":"components/schemas/ACHFileUploadAttemptedEvent","kind":"json-schema","title":"ach.file.upload.attempted","data":{"allOf":[{"$ref":"#/components/schemas/ACHFileUploadEvent"},{"properties":{"eventType":{"enum":["ach.file.upload.attempted"],"type":"string"}},"type":"object"}],"title":"ach.file.upload.attempted"}},"components/schemas/ACHFileUploadFailedEvent":{"id":"components/schemas/ACHFileUploadFailedEvent","kind":"json-schema","title":"ach.file.upload.failed","data":{"allOf":[{"$ref":"#/components/schemas/ACHFileUploadEvent"},{"properties":{"eventType":{"enum":["ach.file.upload.failed"],"type":"string"}},"type":"object"}],"title":"ach.file.upload.failed"}},"components/schemas/ACHFileUploadSucceededEvent":{"id":"components/schemas/ACHFileUploadSucceededEvent","kind":"json-schema","title":"ach.file.upload.succeeded","data":{"allOf":[{"$ref":"#/components/schemas/ACHFileUploadEvent"},{"properties":{"eventType":{"enum":["ach.file.upload.succeeded"],"type":"string"}},"type":"object"}],"title":"ach.file.upload.succeeded"}},"components/schemas/amount":{"id":"components/schemas/amount","kind":"json-schema","title":"amount","data":{"type":"number"}},"components/schemas/transactionFailureReason":{"id":"components/schemas/transactionFailureReason","kind":"json-schema","title":"transactionFailureReason","data":{"enum":["insufficientFunds","chargeback","accountClosed","invalidAccount","unknownReason","invalidCvv","invalidExpirationDate","avsFailed","networkError","cardDeclined","accountFrozen","deceased","invalidRouting","paymentStopped","microdepositsFailed","incorrectNumber","fraudulent","unauthorizedDebit","microdepositsAttemptFailed"],"type":"string"}},"components/schemas/ReconciliationPaymentFailedEvent":{"id":"components/schemas/ReconciliationPaymentFailedEvent","kind":"json-schema","title":"reconciliation.payment.failed","data":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"properties":{"amount":{"$ref":"#/components/schemas/amount"},"eventType":{"enum":["reconciliation.payment.failed"],"type":"string"},"fromInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"reason":{"$ref":"#/components/schemas/transactionFailureReason"},"settlementIds":{"items":{"$ref":"#/components/schemas/readOnlyExternalId"},"type":"array"},"toInstrumentId":{"$ref":"#/components/schemas/paymentInstrumentId"},"transactionId":{"$ref":"#/components/schemas/transactionId"}},"type":"object"}],"title":"reconciliation.payment.failed"}},"components/schemas/replayId":{"id":"components/schemas/replayId","kind":"json-schema","title":"replayId","data":{"description":"Replay's unique identifier.","type":"string"}},"components/schemas/LoanBalanceChangedEvent":{"id":"components/schemas/LoanBalanceChangedEvent","kind":"json-schema","title":"loan.balance.changed","data":{"properties":{"balances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balances of the loan after the balance change."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains a subset of the fields found in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_balances_get"},"href":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_balances_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get loan balances"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response body."},"children":[]}]}]}],"properties":{"authorizedAmount":{"$ref":"#/components/schemas/AuthorizedAmount"},"availableCreditAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available credit amount to use. If the borrower exceeded their credit limit, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For lines of credit only:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes into account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorized purchases decrease the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCreditAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount can be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It happens only when the total amount of payments made by the borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plus the total amount of service credits exceeds the line or draw balance. Any future purchases will first deplete the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overpayment amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to lines of credit or installment loans with multi-advances."},"children":[]}]}]}],"format":"float","type":"number"},"calculatedAt":{"description":"The date and time the balance was calculated.","format":"date-time","type":"string"},"openToBuyAmount":{"$ref":"#/components/schemas/OpenToBuyAmount"},"outstandingBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a loan is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", outstanding balances combine non-due, due, and overdue balances. When a loan is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", outstanding balances are equal to non-accrual balances. When a loan is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outstanding balances are equal to charged-off balances."},"children":[]}]}]}],"properties":{"outstandingFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outstandingTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"outstandingTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total outstanding balance sums outstanding principal, interest, and fees. Also called the loan payoff amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan is charged off, the outstanding totalAmount will be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"overdueBalances":{"description":"Overdue balances represent balances that are overdue.","properties":{"overdueTotalAmount":{"description":"The total overdue balance sums overdue principal, interest, and fees.","format":"float","type":"number"}},"type":"object"},"paidBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If loan balance was affected by transaction(s) (e.g. payment), this object will contain details of the paid amounts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will populate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes in two scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction, a payment or service credit, was applied without triggering a replay. In this scenario, amounts"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will show how much of the loan balance was paid by the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A replay was triggered. In this scenario, the system will sum up how much of the loan balance was paid by all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions that were reapplied from \"replay start timestamp\" until \"replay end timestamp\". If there were no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions in the replay period that impacted the loan balance, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other attributes in the object will be zeros."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside of these scenarios, the values will be zero."},"children":[]}]}]}],"properties":{"paidFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to fees."},"children":[]}]}]}],"format":"float","type":"number"},"paidInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to interest."},"children":[]}]}]}],"format":"float","type":"number"},"paidOverAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stores any excess amount that was not allocated to principal, interest or fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A check in amount greater than outstanding balance was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overpayment portion (aka balance owed to a borrower) will be reported as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOverAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"float","type":"number"},"paidPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal."},"children":[]}]}]}],"format":"float","type":"number"},"paidReimbursementsAmount":{"description":"The total amount of reimbursements that were sent back to a borrower.","format":"float","type":"number"},"paidTotalAmount":{"description":"The paid amount that impacted/lowered the balance.","format":"float","type":"number"}},"type":"object"},"reimbursementAmount":{"description":"The total amount that a lender owes to the borrower. The amount was not sent to the borrower yet.\nAfter a reimbursement is processed, the amount is reduced accordingly.\n","format":"float","type":"number"},"utilizationAmount":{"$ref":"#/components/schemas/UtilizationAmount"}},"type":"object"},"borrowerId":{"$ref":"#/components/schemas/personId"},"eventId":{"description":"The creatingMessageId of the event that caused the balance change.","type":"string"},"eventType":{"enum":["loan.balance.changed"],"type":"string"},"interestAccruedAmount":{"description":"The amount of interest accrued. Only set for daily loan maintenance and catchup interest accrual.","format":"float","nullable":true,"type":"number"},"loanId":{"$ref":"#/components/schemas/loanId"},"replayEndedAt":{"description":"Replay ended at timestamp. Only populated for replay events.","format":"date-time","nullable":true,"type":"string"},"replayId":{"$ref":"#/components/schemas/replayId"},"replayStartedAt":{"description":"Replay started at timestamp. Only populated for replay events.","format":"date-time","nullable":true,"type":"string"}},"title":"loan.balance.changed","type":"object"}},"components/schemas/supercaseId":{"id":"components/schemas/supercaseId","kind":"json-schema","title":"supercaseId","data":{"description":"Supercase's unique identifier.","type":"string"}},"components/schemas/SupercaseChangedEvent":{"id":"components/schemas/SupercaseChangedEvent","kind":"json-schema","title":"supercase.changed","data":{"allOf":[{"properties":{"eventType":{"enum":["supercase.changed"],"type":"string"},"supercaseId":{"$ref":"#/components/schemas/supercaseId"}},"type":"object"},{"$ref":"#/components/schemas/ChangeEvent"}],"title":"supercase.changed"}},"components/schemas/GenericEvent":{"id":"components/schemas/GenericEvent","kind":"json-schema","title":"generic","data":{"properties":{"eventType":{"type":"string"}},"title":"generic","type":"object"}},"components/schemas/eventTypeDefinition":{"id":"components/schemas/eventTypeDefinition","kind":"json-schema","title":"eventTypeDefinition","data":{"description":"The dotted event string.","example":"loan.statuschanged","type":"string"}},"components/schemas/EventPublic":{"id":"components/schemas/EventPublic","kind":"json-schema","title":"EventPublic","data":{"anyOf":[{"$ref":"#/components/schemas/AutopayPaymentRescheduledEvent"},{"$ref":"#/components/schemas/AutopayPaymentCanceledEvent"},{"$ref":"#/components/schemas/CancelAutopayScheduleEvent"},{"$ref":"#/components/schemas/AutopayScheduleChangedEvent"},{"$ref":"#/components/schemas/CardReplacementRequestedEvent"},{"$ref":"#/components/schemas/CardCreatedEvent"},{"$ref":"#/components/schemas/CardStatusChangedEvent"},{"$ref":"#/components/schemas/CaseAssociationAddedEvent"},{"$ref":"#/components/schemas/CaseAssociationRemovedEvent"},{"$ref":"#/components/schemas/CaseDoNotInteractCreatedEvent"},{"$ref":"#/components/schemas/CaseDoNotInteractDeletedEvent"},{"$ref":"#/components/schemas/CaseDoNotInteractUpdatedEvent"},{"$ref":"#/components/schemas/CaseDoNotInteractChangedEvent"},{"$ref":"#/components/schemas/CaseDoNotInteractExpiredEvent"},{"$ref":"#/components/schemas/CaseEscalationChangedEvent"},{"$ref":"#/components/schemas/CaseCreatedEvent"},{"$ref":"#/components/schemas/CaseUpdatedEvent"},{"$ref":"#/components/schemas/CaseDeletedEvent"},{"$ref":"#/components/schemas/CaseChangedEvent"},{"$ref":"#/components/schemas/TemplateDescriptorChangedEvent"},{"$ref":"#/components/schemas/TemplateVersionChangedEvent"},{"$ref":"#/components/schemas/TemplateVersionActivatedEvent"},{"$ref":"#/components/schemas/ContactCreatedEvent"},{"$ref":"#/components/schemas/ContactUpdatedEvent"},{"$ref":"#/components/schemas/ContactDeletedEvent"},{"$ref":"#/components/schemas/InteractionBlockedEvent"},{"$ref":"#/components/schemas/LoanClosedEvent"},{"$ref":"#/components/schemas/LoanCreatedEvent"},{"$ref":"#/components/schemas/LoanCreditLimitChangedEvent"},{"$ref":"#/components/schemas/DrawCreditLimitChangedEvent"},{"$ref":"#/components/schemas/LoanCurrentEvent"},{"$ref":"#/components/schemas/LoanFeeCapitalizedEvent"},{"$ref":"#/components/schemas/LoanOverdueEvent"},{"$ref":"#/components/schemas/LoanOverdueUpdateEvent"},{"$ref":"#/components/schemas/LoanLateFeeBookedEvent"},{"$ref":"#/components/schemas/LoanMigrationSucceededEvent"},{"$ref":"#/components/schemas/LoanMigrationFailedEvent"},{"$ref":"#/components/schemas/LoanModificationFeeBookedEvent"},{"$ref":"#/components/schemas/LoanFeeBooked"},{"$ref":"#/components/schemas/LoanFeeCanceledEvent"},{"$ref":"#/components/schemas/LoanFeeChangedEvent"},{"$ref":"#/components/schemas/LoanOwnerChangedEvent"},{"$ref":"#/components/schemas/RemainingBalancesDeferredEvent"},{"$ref":"#/components/schemas/LoanPromoProgramActivatedEvent"},{"$ref":"#/components/schemas/LoanPromoProgramCanceledEvent"},{"$ref":"#/components/schemas/LoanPromoProgramCreatedEvent"},{"$ref":"#/components/schemas/LoanPromoProgramExercisedEvent"},{"$ref":"#/components/schemas/LoanPromoProgramReactivatedEvent"},{"$ref":"#/components/schemas/LoanPromoProgramUpdatedEvent"},{"$ref":"#/components/schemas/LoanRateCreatedEvent"},{"$ref":"#/components/schemas/LoanRateUpdatedEvent"},{"$ref":"#/components/schemas/LoanRefundedEvent"},{"$ref":"#/components/schemas/InstallmentRefundedEvent"},{"$ref":"#/components/schemas/LoanReimbursementInitiatedEvent"},{"$ref":"#/components/schemas/LoanReimbursementProcessedEvent"},{"$ref":"#/components/schemas/LoanStatusChangedEvent"},{"$ref":"#/components/schemas/PeriodStartedEvent"},{"$ref":"#/components/schemas/ObligationStatusChangedEvent"},{"$ref":"#/components/schemas/SendCommunicationEvent"},{"$ref":"#/components/schemas/StatementCreatedEvent"},{"$ref":"#/components/schemas/PaymentInstrumentCreatedEvent"},{"$ref":"#/components/schemas/PaymentInstrumentUpdatedEvent"},{"$ref":"#/components/schemas/PaymentInstrumentDeactivatedEvent"},{"$ref":"#/components/schemas/PersonBankruptcyDeceasedStartMonitoringEvent"},{"$ref":"#/components/schemas/PersonConsentUpdatedEvent"},{"$ref":"#/components/schemas/PersonCreatedEvent"},{"$ref":"#/components/schemas/PersonSCRAStartMonitoringEvent"},{"$ref":"#/components/schemas/PaymentChargebackEvent"},{"$ref":"#/components/schemas/PaymentChargebackReversedEvent"},{"$ref":"#/components/schemas/PaymentFailedEvent"},{"$ref":"#/components/schemas/PaymentInitiatedEvent"},{"$ref":"#/components/schemas/PaymentPendingEvent"},{"$ref":"#/components/schemas/PaymentReversedEvent"},{"$ref":"#/components/schemas/PaymentScheduledEvent"},{"$ref":"#/components/schemas/PaymentSucceededEvent"},{"$ref":"#/components/schemas/PaymentRescheduledEvent"},{"$ref":"#/components/schemas/PaymentDueTodayEvent"},{"$ref":"#/components/schemas/PaymentHoldDaysExpiredEvent"},{"$ref":"#/components/schemas/PurchaseAuthorizedEvent"},{"$ref":"#/components/schemas/PurchaseSettledEvent"},{"$ref":"#/components/schemas/PurchaseAppliedEvent"},{"$ref":"#/components/schemas/PurchaseCreatedEvent"},{"$ref":"#/components/schemas/PurchaseChangedEvent"},{"$ref":"#/components/schemas/PurchaseDisputeCreatedEvent"},{"$ref":"#/components/schemas/PurchaseDisputeUpdatedEvent"},{"$ref":"#/components/schemas/LoanCreditReportingCreatedEvent"},{"$ref":"#/components/schemas/LoanCreditReportingStoppedEvent"},{"$ref":"#/components/schemas/InterestCapitalizedEvent"},{"$ref":"#/components/schemas/ACHFileCreatedEvent"},{"$ref":"#/components/schemas/ACHFileUploadAttemptedEvent"},{"$ref":"#/components/schemas/ACHFileUploadFailedEvent"},{"$ref":"#/components/schemas/ACHFileUploadSucceededEvent"},{"$ref":"#/components/schemas/ReconciliationPaymentFailedEvent"},{"$ref":"#/components/schemas/LoanBalanceChangedEvent"},{"$ref":"#/components/schemas/SupercaseChangedEvent"},{"$ref":"#/components/schemas/GenericEvent"}],"properties":{"eventType":{"$ref":"#/components/schemas/eventTypeDefinition"}},"required":["eventType"],"type":"object"}},"components/schemas/InteractionsPaging":{"id":"components/schemas/InteractionsPaging","kind":"json-schema","title":"InteractionsPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Interaction"},"type":"array"}},"type":"object"}]}},"components/schemas/NoteCategory":{"id":"components/schemas/NoteCategory","kind":"json-schema","title":"NoteCategory","data":{"default":"generic","description":"Specifies the nature of a Note\n","enum":["generic","escalationCreateReason","escalationUpdateReason","escalationCancelReason"],"type":"string"}},"components/schemas/NoteResponse":{"id":"components/schemas/NoteResponse","kind":"json-schema","title":"A borrower, case, supercase or interaction note","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"archived":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note has been archived."},"children":[]}]}]}],"type":"boolean"},"archivedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"archivedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for archiving the note.\nCan be an agent or automated system process.\n"},"caseId":{"description":"Identifier of the case that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"category":{"$ref":"#/components/schemas/NoteCategory"},"content":{"description":"The content of the note.","type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the note.\nCan be an agent or automated system process.\n"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deletedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Latest user identifier who deleted the note."},"edited":{"default":false,"description":"Indicates whether the note was edited.\n","readOnly":true,"type":"boolean"},"id":{"description":"The note identifier.","readOnly":true,"type":"string"},"important":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note is important."},"children":[]}]}]}],"type":"boolean"},"interactionId":{"description":"Identifier of the interaction that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"object":{"default":"note","enum":["note"],"readOnly":true,"type":"string"},"oldContent":{"type":"array"},"pinned":{"default":false,"description":"Specify that this note should be sorted to the top of the list\nby default.\n","type":"boolean"},"sensitiveData":{"default":false,"description":"Indicates whether the note contains sensitive information.\n","type":"boolean"},"status":{"enum":["active","inactive"],"type":"string"},"supercaseId":{"description":"Identifier of the supercase that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"taskableInstruction":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note is intended to be an instruction which creates a review task."},"children":[]}]}]}],"type":"boolean"},"type":{"enum":["borrowerNote","caseNote","interactionNote","supercaseGlobalNote","supercasePrivateNote"],"readOnly":true,"type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for last updating the note.\nCan be an agent or automated system process.\n"}},"type":"object"}],"description":"A borrower, case, supercase or interaction can have a note associated with it. Each note can only be associated with one of these objects.\n","title":"A borrower, case, supercase or interaction note"}},"components/schemas/NoteRequest":{"id":"components/schemas/NoteRequest","kind":"json-schema","title":"A borrower, case, supercase or interaction note","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"archived":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note has been archived."},"children":[]}]}]}],"type":"boolean"},"archivedAt":{"format":"date-time","readOnly":true,"type":"string"},"archivedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for archiving the note.\nCan be an agent or automated system process.\n"},"caseId":{"description":"Identifier of the case that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"category":{"$ref":"#/components/schemas/NoteCategory"},"content":{"description":"The content of the note.","type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the note.\nCan be an agent or automated system process.\n"},"deletedAt":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deletedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for deleting the note.\nCan be an agent or automated system process.\n"},"edited":{"default":false,"description":"Indicates whether the note was edited.\n","readOnly":true,"type":"boolean"},"id":{"description":"The note identifier.","readOnly":true,"type":"string"},"important":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note is important."},"children":[]}]}]}],"type":"boolean"},"interactionId":{"description":"Identifier of the interaction that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"pinned":{"default":false,"description":"Specify that this note should be sorted to the top of the list\nby default.\n","type":"boolean"},"sensitiveData":{"default":false,"description":"Indicates whether the note contains sensitive information.\n","type":"boolean"},"status":{"enum":["active","inactive"],"type":"string"},"supercaseId":{"description":"Identifier of the supercase that the note belongs to.","nullable":true,"readOnly":true,"type":"string"},"taskableInstruction":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the note is intended to be an instruction which creates a review task."},"children":[]}]}]}],"type":"boolean"},"type":{"enum":["borrowerNote","caseNote","interactionNote","supercaseGlobalNote","supercasePrivateNote"],"readOnly":true,"type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for last updating the note.\nCan be an agent or automated system process.\n"}},"type":"object"}],"description":"A borrower, case, supercase or interaction can have a note associated with it. Each note can only be associated with one of these objects.\n","title":"A borrower, case, supercase or interaction note"}},"components/schemas/APIKeyDescription":{"id":"components/schemas/APIKeyDescription","kind":"json-schema","title":"APIKeyDescription","data":{"description":"A description of the API key. This field is optional and can be used to provide additional context about the API key.\n","maxLength":200,"minLength":1,"nullable":true,"type":"string"}},"components/schemas/WhitelistedIPs":{"id":"components/schemas/WhitelistedIPs","kind":"json-schema","title":"WhitelistedIPs","data":{"description":"IP addresses or CIDR blocks for which to restrict access to this API key.\n","example":["1.1.1.1","2.2.2.2","10.10.0.0/16"],"items":{"type":"string"},"nullable":true,"type":"array"}},"components/schemas/ResponseAPIKeyNoSecret":{"id":"components/schemas/ResponseAPIKeyNoSecret","kind":"json-schema","title":"ResponseAPIKeyNoSecret","data":{"properties":{"companyId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deletedAt":{"format":"date-time","type":"string"},"description":{"$ref":"#/components/schemas/APIKeyDescription"},"id":{"type":"string"},"key":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userId":{"type":"string"},"whitelistedIPs":{"$ref":"#/components/schemas/WhitelistedIPs"}},"type":"object"}},"components/schemas/RequestBodyAPIKeyNoSecret":{"id":"components/schemas/RequestBodyAPIKeyNoSecret","kind":"json-schema","title":"RequestBodyAPIKeyNoSecret","data":{"properties":{"description":{"$ref":"#/components/schemas/APIKeyDescription"},"userId":{"type":"string"},"whitelistedIPs":{"$ref":"#/components/schemas/WhitelistedIPs"}},"required":["userId"],"type":"object"}},"components/schemas/APIKeyAPIVersion":{"id":"components/schemas/APIKeyAPIVersion","kind":"json-schema","title":"APIKeyAPIVersion","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the API this API key is tied to. Must be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-05-22","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning":{"id":"components/schemas/RequestBodyAPIKeyUpdateAPIVersioning","kind":"json-schema","title":"RequestBodyAPIKeyUpdateAPIVersioning","data":{"properties":{"apiVersion":{"$ref":"#/components/schemas/APIKeyAPIVersion"},"description":{"$ref":"#/components/schemas/APIKeyDescription"},"whitelistedIPs":{"$ref":"#/components/schemas/WhitelistedIPs"}},"type":"object"}},"components/schemas/ResponseAPIKeyNoSecretAPIVersioning":{"id":"components/schemas/ResponseAPIKeyNoSecretAPIVersioning","kind":"json-schema","title":"ResponseAPIKeyNoSecretAPIVersioning","data":{"properties":{"apiVersion":{"$ref":"#/components/schemas/APIKeyAPIVersion"},"apiVersionDowngradeNotAllowedAfter":{"description":"A UTC timestamp corresponding to when the API key's version can no longer be downgraded. This timestamp is set to 7 days after the API key's version is updated.\n","format":"date-time","type":"string"},"apiVersionUpdatedAt":{"description":"A UTC timestamp corresponding to when the API key's version was last updated. This timestamp is updated when the API key's version is updated.\n","format":"date-time","type":"string"},"companyId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deletedAt":{"format":"date-time","type":"string"},"description":{"$ref":"#/components/schemas/APIKeyDescription"},"id":{"type":"string"},"key":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userId":{"type":"string"},"whitelistedIPs":{"$ref":"#/components/schemas/WhitelistedIPs"}},"type":"object"}},"components/schemas/FeeApiName":{"id":"components/schemas/FeeApiName","kind":"json-schema","title":"FeeApiName","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the dynamic fee configuration for this loan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"example":"modificationFee","type":"string"}},"components/schemas/FeeDisplayName":{"id":"components/schemas/FeeDisplayName","kind":"json-schema","title":"FeeDisplayName","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the fee. The display name of the fee is either set by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customDisplayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (that can be passed in the API)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was configured in the loan type (this is the default value.)"},"children":[]}]}]}],"example":"Modification fee","type":"string"}},"components/schemas/IndexRate":{"id":"components/schemas/IndexRate","kind":"json-schema","title":"IndexRate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index interest rate for a loan type. The index rate is used in conjunction with an interest rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a loan of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the effective interest rate for that loan."},"children":[]}]}]}],"properties":{"annualRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest rate value for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country. English short name according to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]}],"maxLength":2,"minLength":2,"type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index rate end date in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date is inclusive (i.e., the rate is also applied on the end date)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the rate is applicable until it changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING: If there is no index rate available for a given date, the system will assume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the index rate is 0. It is highly recommended that you set the \"last\" index rate's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end date to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so that there is always an index rate that is applicable."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"externalId":{"$ref":"#/components/schemas/externalId","description":"The external unique identifier of the index rate."},"indexDescription":{"description":"The index interest rate description. For example: \"1 Month LIBOR Rate\" or \"Custom rate\".\n","type":"string"},"startDate":{"description":"The start date of the index rate in the product timezone.\n\nThe start date is inclusive (i.e., the rate is applied on the start date).\n\nWhen a new Index Interest Rate value is added, the previous rate\n(if it exists) will have its end date set to one calendar day before\nthe new rate's start date.\n\nIf the new rate's start date is in the past, the Peach system will replay all\n\"active\" loans with the new Index Interest Rate value and re-accrue loans' interest.\n(To clarify, it applied to the \"active\" loans at the time of\nIndex Interest Rate addition.)\n\nWARNING: Replaying the entire portfolio of loans might take a long time.\nIt is recommended that you set the new Index Interest Rate at night.\n","format":"date","type":"string"}},"required":["annualRate","startDate"],"type":"object"}},"components/schemas/IndexRateResult":{"id":"components/schemas/IndexRateResult","kind":"json-schema","title":"IndexRateResult","data":{"allOf":[{"properties":{"id":{"description":"The index rate's unique identifier.","readOnly":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/IndexRate"}]}},"components/schemas/IndexRatePaging":{"id":"components/schemas/IndexRatePaging","kind":"json-schema","title":"IndexRatePaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/IndexRateResult"},"type":"array"}},"type":"object"}]}},"components/schemas/IndexRateUpdate":{"id":"components/schemas/IndexRateUpdate","kind":"json-schema","title":"IndexRateUpdate","data":{"properties":{"annualRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest rate value for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index rate end date in the product timezone. The end date is inclusive. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you do not know when the rate will expire. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the rate is applicable until it changes."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"indexDescription":{"description":"The index interest rate description. For example: \"1 Month LIBOR Rate\" or \"Custom rate\".\n","type":"string"}},"type":"object"}},"components/schemas/LoansPaging":{"id":"components/schemas/LoansPaging","kind":"json-schema","title":"loans","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"allOf":[{"$ref":"#/components/schemas/Loan"},{"properties":{"mainBorrowerExternalId":{"description":"The external identifier of the main borrower of the loan.","type":"string"},"newInterestTimestampStartedAt":{"description":"The timestamp of when the new interest timestamp started.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}]},"type":"array"}},"type":"object"}],"title":"loans"}},"components/schemas/LoansMinimalPaging":{"id":"components/schemas/LoansMinimalPaging","kind":"json-schema","title":"LoansMinimalPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"properties":{"externalId":{"description":"The external identifier of the loan.","type":"string"},"id":{"type":"string"},"loanTypeId":{"description":"The loan type identifier. This is created specifically for each lender's loan product by Peach.","type":"string"},"lockStatus":{"description":"Is the loan locked for replay?\n","type":"boolean"},"mainBorrowerExternalId":{"description":"The external identifier of the main borrower of the loan.","type":"string"},"mainBorrowerId":{"description":"The identifier of the main borrower of the loan.","type":"string"},"migrationStatus":{"default":"nonMigrated","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan migration status. This attribute can be updated by the Peach system only."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonMigrated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this is a non-migrated loan. Most loans are expected to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonMigrated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the lender can add objects to the loan in the past."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system is migrating the loan. Objects cannot be modified or added."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was successfully migrated. After a successful migration the loan status will be changed to one of the following statuses: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan migration attempt failed. The loan will remain in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. You can update the loan details and try to migrate again by calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Migrate loan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"enum":["nonMigrated","prepMigration","migrating","completed","failed"],"type":"string"},"newInterestTimestampStartedAt":{"description":"The timestamp of when the new interest timestamp started.","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/NotificationType":{"id":"components/schemas/NotificationType","kind":"json-schema","title":"notificationHandler","data":{"allOf":[{"$ref":"#/components/schemas/VersionedMixin"},{"properties":{"channel":{"allOf":[{"nullable":true,"type":"string"},{"$ref":"#/components/schemas/InteractionChannel"}]},"delay":{"description":"Length of time after a triggering condition to wait before sending notification.\n","nullable":true,"type":"integer"},"onCondition":{"$ref":"#/components/schemas/onCondition"},"onOutcome":{"$ref":"#/components/schemas/ProcessOutcome"},"onStatus":{"$ref":"#/components/schemas/ProcessStatus"},"templateId":{"description":"Communication template identifier to create and send notification.\n","nullable":true,"type":"integer"},"theme":{"allOf":[{"nullable":true,"type":"string"},{"$ref":"#/components/schemas/InteractionTheme"}]},"unit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time units for setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time."},"children":[]}]}]}],"enum":["calendarDays","businessDays"],"nullable":true,"type":"string"}},"type":"object"}],"title":"notificationHandler"}},"components/schemas/PaymentProcessorFundingInstrument":{"id":"components/schemas/PaymentProcessorFundingInstrument","kind":"json-schema","title":"PaymentProcessorFundingInstrument","data":{"properties":{"id":{"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the funding instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument can be used for reconciliation payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument is pending to be verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the instrument is not active and cannot be used for reconciliation payments."},"children":[]}]}]}]}],"enum":["active","inactive","pending"],"type":"string"}},"type":"object"}},"components/schemas/PaymentProcessorMutableFields":{"id":"components/schemas/PaymentProcessorMutableFields","kind":"json-schema","title":"PaymentProcessorMutableFields","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"achBatchHeaderCompanyId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the batch header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2837461011"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achBatchHeaderCompanyName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the batch header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEACH FIN ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achBatchHeaderOriginatingDFIId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the batch header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12773923"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is NOT provided (aka null or empty) as part of the configuration, the system will automatically set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achFileHeaderImmediateDestination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without the last digits."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achFileHeaderImmediateDestination=121140399"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achBatchHeaderOriginatingDFIId=12114039"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achCutoff":{"description":"The cutoff time for ACH processing, in the payment processor's timezone. Use 24-hour format. For example: \"19:00\"\n","format":"time","type":"string"},"achFeeAmount":{"description":"The fee charged by the payment processor for regular ACH transactions. For example: 0.05\n","format":"float","type":"number"},"achFeeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the fee is charged by the payment processor. If the full amount is transferred, and fees are charged monthly, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gross"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If fees are deducted from the amount transferred, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["gross","net"],"type":"string"},"achFileHeaderImmediateDestination":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the file header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"121140399"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achFileHeaderImmediateDestinationName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the file header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SILICON VALLEY BANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achFileHeaderImmediateOrigin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the file header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1456726789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achFileHeaderImmediateOriginName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data element that is part of the file header record. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEACH FINANCE INC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achSECCode":{"default":"PPD","description":"The Standard Entry Class Code within ACH.\n","enum":["CCD","PPD","WEB"],"type":"string"},"achSameDayCutoff":{"description":"The cutoff time for ACH same day processing, in the payment processor's timezone. Use 24-hour format. For example: \"10:00\"\n","format":"time","type":"string"},"achSameDayFeeAmount":{"description":"The fee charged by the payment processor for same day ACH transactions. For example: 0.50\n","format":"float","type":"number"},"encryptionMethodIncoming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The encryption method that Peach system will use to decrypt the incoming files to Peach."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure you use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to encrypt the files sent to Peach or uploaded to SFTP for Peach. Keep the value empty if no encryption is needed."},"children":[]}]}]}],"enum":["GPG"],"nullable":true,"type":"string"},"encryptionMethodOutgoing":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The encryption method that Peach system will use to encrypt the outgoing files from Peach. Keep the value empty if no encryption is needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encryptionMethodOutgoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, a value must be set for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["GPG"],"nullable":true,"type":"string"},"isDefault":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark the payment processor as default for the company. Only one payment processor can be default. If a new payment processor is created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDefault=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there is another payment processor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDefault=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDefault=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other/existing processor."},"children":[]}]}]}],"type":"boolean"},"isFileNameDefaultConvention":{"default":true,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", files (e.g. ACH) will be named based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACHP_MMDDYYYYHHMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" convention. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACHP_110320211305"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", files (e.g. ACH) will be named based on a custom implementation. Do not set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless you've coordinated with the Peach team."},"children":[]}]}]}]}],"type":"boolean"},"peachPublicKey":{"description":"Peach's public key to encrypt the incoming files to Peach.\n","readOnly":true,"type":"string"},"privateKeyExpires":{"default":false,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signOutgoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Setting this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signOutgoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the private key generated for signing outgoing files will have an expiration date of 2 years from the time of generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default), the private key does not expire."},"children":[]}]}]}]}],"type":"boolean"},"processorName":{"description":"The name of the payment processor. For example: Silicon Valley Bank or Wells Fargo.\n","type":"string"},"sftpAccessMethod":{"default":"usernamePassword","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to access the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpHostname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usernamePassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpUsername"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpPassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPrivateKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpSSHPeachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created by peach."},"children":[]}]}]}]}],"enum":["usernamePassword","keys","disabled"],"type":"string"},"sftpAchConfirmationFileNameRegex":{"description":"The name of the ACH confirmation file. The format is a regular expression.\nIf you are not sure how to set up the regular expression, please contact the Peach team by providing a few examples of file names.\n\nIf the value is null, we assume that the processor doesn't support ACH confirmation files and any upload of an ACH file is considered as successful.\n","nullable":true,"type":"string"},"sftpAchReturnFileNameRegex":{"description":"The name of the ACH return file. The format is a regular expression.\nIf you are not sure how to set up the regular expression, please contact the Peach team by providing a few examples of file names.\n","type":"string"},"sftpCdDirInbox":{"description":"The folder where files (e.g. ACH returns) will be downloaded from. The system will change directory into this folder before\nperforming the download.\n","type":"string"},"sftpCdDirOutbox":{"description":"The folder where files (e.g. ACH instructions) will be uploaded. The system will change directory into this folder before\nperforming the upload.\n","type":"string"},"sftpHostname":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hostname for SFTP. Host name should not contain a scheme, so don't put "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftp://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the front. You may optionally specify a port"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"like so: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com:222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no port is supplied a default of 22 will be used."},"children":[]}]}]}],"pattern":"^[^/]+$","type":"string"},"sftpPassword":{"description":"The password for SFTP.","nullable":true,"type":"string","writeOnly":true},"sftpSSHDisabledAlgorithms":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A json object of any algorithms that need to be disabled when accessing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sftpHostname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a private key. This should be null in most scenarios."},"children":[]}]}]}],"nullable":true,"type":"object"},"sftpSSHPeachPublicKey":{"description":"Peach public key to used to log into sftpHostname.\n","readOnly":true,"type":"string"},"sftpUsername":{"description":"The username for SFTP.","nullable":true,"type":"string"},"signOutgoing":{"default":false,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, outgoing files will be encrypted with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and signed with peach's private key. Make sure to set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encryptionMethodOutgoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, outgoing files will not be signed with peach's private key."},"children":[]}]}]}]}],"type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment processor is in the process of being configured and not ready to be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment processor is ready to process payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment processor was deprecated, and new payments cannot be processed."},"children":[]}]}]}]}],"enum":["draft","active","deprecated"],"type":"string"},"thirdPartyPublicKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third party's (e.g. lender or bank) public key to use to encrypt the outgoing files from Peach. A value must be passed if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encryptionMethodOutgoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set."},"children":[]}]}]}],"nullable":true,"type":"string","writeOnly":true},"timezone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timezone used by this payment processor. For example: \"America/Los_Angeles\""},"children":[]}]}]}],"type":"string"}},"type":"object"}]}},"components/schemas/SuccessfulStatusTransition":{"id":"components/schemas/SuccessfulStatusTransition","kind":"json-schema","title":"SuccessfulStatusTransition","data":{"properties":{"dayType":{"$ref":"#/components/schemas/DayType"},"numDays":{"minimum":1,"type":"integer"}},"type":"object"}},"components/schemas/PaymentProcessorResponseFields":{"id":"components/schemas/PaymentProcessorResponseFields","kind":"json-schema","title":"PaymentProcessorResponseFields","data":{"properties":{"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment processor is external to Peach-managed ACH processing."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"isSettlementRequired":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this payment processor participates in Peach investor settlement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(transfer creation, reconciliation funding, and settlement NACHA generation)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is set only at processor creation (defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed afterward."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"successfulStatusTransition":{"allOf":[{"$ref":"#/components/schemas/SuccessfulStatusTransition"}],"readOnly":true}},"type":"object"}},"components/schemas/PaymentProcessor":{"id":"components/schemas/PaymentProcessor","kind":"json-schema","title":"Payment Processor","data":{"allOf":[{"properties":{"fundingInstruments":{"description":"The funding instruments that are associated with the payment processor.","items":{"$ref":"#/components/schemas/PaymentProcessorFundingInstrument"},"readOnly":true,"type":"array"},"paymentTypes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment types that will be processed by the payment processor. Currently, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported only."},"children":[]}]}]}],"items":{"enum":["ach","debitCard","creditCard"],"type":"string"},"type":"array"},"processorType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of payment processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achDirectUS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will create NACHA files and upload directly to lender's bank SFTP."},"children":[]}]}]}]}],"enum":["achDirectUS"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentProcessorMutableFields"},{"$ref":"#/components/schemas/PaymentProcessorResponseFields"}],"required":["paymentTypes","processorType","processorName","status","timezone","sftpAchReturnFileNameRegex","sftpAccessMethod"],"title":"Payment Processor"}},"components/schemas/PaymentProcessorCreateOnlyFields":{"id":"components/schemas/PaymentProcessorCreateOnlyFields","kind":"json-schema","title":"PaymentProcessorCreateOnlyFields","data":{"properties":{"isExternal":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment processor is external to Peach-managed ACH processing."},"children":[]}]}]}],"type":"boolean"},"isSettlementRequired":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settable only at processor creation; defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marks the processor for Peach investor settlement (transfer creation, reconciliation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"funding, and settlement NACHA generation)."},"children":[]}]}]}],"type":"boolean"},"successfulStatusTransition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when a transaction transitions to succeeded after processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dayType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted or null, defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"dayType":{"enum":["business","calendar"],"nullable":true,"type":"string"},"numDays":{"minimum":1,"nullable":true,"type":"integer"}},"type":"object"}},"type":"object"}},"components/schemas/PaymentProcessorCreateRequest":{"id":"components/schemas/PaymentProcessorCreateRequest","kind":"json-schema","title":"PaymentProcessorCreateRequest","data":{"allOf":[{"properties":{"paymentTypes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment types that will be processed by the payment processor. Currently, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported only."},"children":[]}]}]}],"items":{"enum":["ach","debitCard","creditCard"],"type":"string"},"type":"array"},"processorType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of payment processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achDirectUS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach system will create NACHA files and upload directly to lender's bank SFTP."},"children":[]}]}]}]}],"enum":["achDirectUS"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentProcessorMutableFields"},{"$ref":"#/components/schemas/PaymentProcessorCreateOnlyFields"}]}},"components/schemas/PaymentProcessorUpdateRequest":{"id":"components/schemas/PaymentProcessorUpdateRequest","kind":"json-schema","title":"PaymentProcessorUpdateRequest","data":{"allOf":[{"properties":{"successfulStatusTransition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when a transaction transitions to succeeded after processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dayType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted or null, defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"dayType":{"enum":["business","calendar"],"nullable":true,"type":"string"},"numDays":{"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"updatePeachKeys":{"default":false,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the peach keys for encrypting and decrypting incoming files to Peach are updated. The new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"peachPublicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, the peach encryption keys are not changed"},"children":[]}]}]}]}],"type":"boolean","writeOnly":true}},"type":"object"},{"$ref":"#/components/schemas/PaymentProcessorMutableFields"}]}},"components/schemas/BorrowerPaging":{"id":"components/schemas/BorrowerPaging","kind":"json-schema","title":"BorrowerPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Borrower"},"type":"array"}},"type":"object"}]}},"components/schemas/PersonSearchPaging":{"id":"components/schemas/PersonSearchPaging","kind":"json-schema","title":"PersonSearchPaging","data":{"allOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/Person"},"type":"array"},"search":{"properties":{"maxScore":{"description":"Number representing the maximum scoring result in the results.\n","format":"float","type":"number"},"scores":{"description":"Object mapping result ID's to their score in the search results.\n","type":"object"}},"type":"object"}},"type":"object"}]}},"components/schemas/BorrowerNoIdentity":{"id":"components/schemas/BorrowerNoIdentity","kind":"json-schema","title":"BorrowerNoIdentity","data":{"anyOf":[{"$ref":"#/components/schemas/PersonNoIdentity"},{"$ref":"#/components/schemas/BusinessNoIdentity"}]}},"components/schemas/CanInteractCommonProps":{"id":"components/schemas/CanInteractCommonProps","kind":"json-schema","title":"CanInteractCommonProps","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The common parameters of a request to determine whether the interaction is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed based on the history of interactions with a borrower and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"theme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"properties":{"channel":{"$ref":"#/components/schemas/InteractionChannel"},"checkAtCompanyNoon":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do time-based checks based on noon today, instead of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"now. This does not override other reasons a check can fail: the borrower"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"having a Do Not Interact in place, having reached the interaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequency limit, etc.  This is useful for generating borrower campaigns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the morning to be carried out during business hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where possible, it's always better to check permission right before an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action. Many things can change (payments are made, other automated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interactions are sent, consents/addresses can be updated) from when you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan something to happen to when it actually happens. Lenders are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responsible for ensuring it is still permissible to conduct the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interaction."},"children":[]}]}]}],"type":"boolean"},"isAutodialed":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if an interaction is prerecorded or autodialed call. This attribute"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is relevant when channel="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no value is passed, we'll assume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isAutodialed="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (meaning manual call). If isAutodialed="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the contact's consentAutodialedCall="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" we'll return result="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information read Telephone Consumer Protection Act (TCPA)."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"loanId":{"$ref":"#/components/schemas/AssociatedLoanId"},"loanIds":{"$ref":"#/components/schemas/AssociatedLoanIds"},"loansFromCollCase":{"$ref":"#/components/schemas/LoansFromCollCase"},"subject":{"$ref":"#/components/schemas/InteractionSubject"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"required":["channel"],"type":"object"}},"components/schemas/CanInteractByContactIdentifier":{"id":"components/schemas/CanInteractByContactIdentifier","kind":"json-schema","title":"canInteractByContactId","data":{"allOf":[{"$ref":"#/components/schemas/CanInteractCommonProps"},{"properties":{"contactExternalId":{"description":"The lender's identifier of the contact information.\n","type":"string","writeOnly":true},"contactId":{"description":"An identifier of an existing contact.\n","type":"string"}},"required":["contactId"],"type":"object"}],"title":"canInteractByContactId"}},"components/schemas/InteractionCanInteractResult":{"id":"components/schemas/InteractionCanInteractResult","kind":"json-schema","title":"InteractionCanInteractResult","data":{"properties":{"result":{"type":"boolean"}},"type":"object"}},"components/schemas/DoNotInteractEndDate":{"id":"components/schemas/DoNotInteractEndDate","kind":"json-schema","title":"DoNotInteractEndDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A future date when interaction restrictions will be lifted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value format is date only, without time. If today is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"restriction will remain until the end of day in the product timezone."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remain in effect until"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Remove do not interact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is called or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to a date in the past."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"}},"components/schemas/schemas-TimeOfDay":{"id":"components/schemas/schemas-TimeOfDay","kind":"json-schema","title":"schemas-TimeOfDay","data":{"properties":{"fromHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From hour in the borrower's home address timezone. Value range is 0-23. 0=Midnight...23=11 PM."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be smaller than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","type":"number"},"toHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To hour in the borrower's home address timezone. Value range is 0-23. 0=Midnight...24=Midnight of following day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be smaller than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","type":"number"}},"required":["fromHour","toHour"],"type":"object"}},"components/schemas/DoNotInteractUpdate":{"id":"components/schemas/DoNotInteractUpdate","kind":"json-schema","title":"doNotInteract","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the Do Not Interact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The only data that can be updated after creation of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doNoInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are external reference and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the ending date."},"children":[]}]}]}],"properties":{"caseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the case to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}],"readOnly":true,"type":"string"},"channels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel(s) for which outbound interactions with a borrower are blocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all channels."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DoNotInteractChannel"},"type":"array"},"contactLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of contact labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's mobile phone is labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's work phone is labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's home phone is labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person's home address is labeled as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ContactLabel"},"type":"array"},"daysOfWeek":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of days of week at which to block."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid range is 1-7. 1=Monday...7=Sunday. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1, 2, 4]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the day of week matches "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the values specified here, then the interaction is blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this array is empty, then the interaction is blocked for all days of week."},"children":[]}]}]}]}],"example":[1,2,4],"items":{"format":"int32","type":"number"},"type":"array"},"endDate":{"$ref":"#/components/schemas/DoNotInteractEndDate"},"object":{"default":"doNotInteract","enum":["doNotInteract"],"readOnly":true,"type":"string"},"personId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the borrower to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}],"readOnly":true,"type":"string"},"source":{"default":"service","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DoNotInteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instance was created. This is used by the internal case processing to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether to stop blocking interactions when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" changes state. This may not be returned by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default depending on your configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": created by an external user through an authorized HTTP request to the API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": created by internal server process, or an API call from a recognized Peach service within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"virtual private cloud (VPC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": created by SQL or manual entry, this is prevented except for rare maintenance situations."},"children":[]}]}]}]}],"enum":["api","service","manual"],"readOnly":true,"type":"string"},"themes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Theme(s) for which outbound interactions with a borrower are blocked. Use value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all themes. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsAccountCredentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opsCollDebt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to stop debt collection interactions."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DoNotInteractTheme"},"type":"array"},"timesOfDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of times of day at which to block—in hour resolution."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the time falls into "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the ranges specified here, then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the interaction is blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this array is empty, then the interaction is blocked for all times of day."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/schemas-TimeOfDay"},"type":"array"},"timezone":{"description":"The time zone where the borrower is located. If provided, the time zone will be used for restriction. If not provided, the system will use the borrower's home address time zone.\n","type":"string"}},"title":"doNotInteract","type":"object"}},"components/schemas/DoNotInteract":{"id":"components/schemas/DoNotInteract","kind":"json-schema","title":"doNotInteract","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/DoNotInteractUpdate"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel(s) and theme(s) for which interactions with a borrower are blocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interactions with theme="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outOpsServicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be blocked since they"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are typically initiated by a borrower."},"children":[]}]}]}],"properties":{"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for blocking interactions with a borrower. The value format is date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only, without time. The start date can be a future date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not provided, or equal to today's date, or a date in the past, then the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doNotIteract"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be effective as soon as we process the request."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"}],"title":"doNotInteract"}},"components/schemas/ConsentItem":{"id":"components/schemas/ConsentItem","kind":"json-schema","title":"consent","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents special consents or permissions. Consents are typically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given in writing to a lender."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electronicComms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower hasn't consented or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has revoked consent to electronic communications. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consented"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactPersonWork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A borrower or their attorney gave a written"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consent to contact borrower's employer for debt collection. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactPersonRepByAttorney"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates whether a lender is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed to contact a borrower represented by an attorney. If the attorney"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gave a written consent to interact with the borrower, set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consented"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactPersonUnusualTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A person or their attorney gave"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"written consent to interact with the person at some unusual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"place or time. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autodialedColl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Consent to receive autodialed or pre-recorded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection calls from creditors or third-party collectors. If no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value is provided, we will assume autodialedColl is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consented"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"more information read Telephone Consumer Protection Act (TCPA)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consented"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executeWageAssignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consented"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the person consented to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"execute a wage assignment agreement. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactServicememberUnitOrCommander"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Consent to contact a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"servicemember's military unit or chain of command to collect on a debt. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"enum":["electronicComms","contactPersonWork","contactPersonRepByAttorney","contactPersonUnusualTime","autodialedColl","executeWageAssignment","contactServicememberUnitCollDebt"],"type":"string"},"object":{"default":"consent","enum":["consent"],"readOnly":true,"type":"string"},"value":{"description":"Consent can be granted and revoked by a borrower.\n","enum":["consented","revoked"],"type":"string"}},"required":["name","value"],"type":"object"}],"title":"consent"}},"components/schemas/Consents":{"id":"components/schemas/Consents","kind":"json-schema","title":"Consents","data":{"items":{"$ref":"#/components/schemas/ConsentItem"},"type":"array"}},"components/schemas/ConsentArray":{"id":"components/schemas/ConsentArray","kind":"json-schema","title":"consent","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"$ref":"#/components/schemas/Consents"}},"type":"object"}],"title":"consent"}},"components/schemas/DocumentUploadLink":{"id":"components/schemas/DocumentUploadLink","kind":"json-schema","title":"DocumentUploadLink","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"caseId":{"description":"The identifier of the case associated with the doc upload link","nullable":true,"type":"string"},"contactId":{"description":"The identifier of the contact to which the doc upload link will be sent","type":"string"}},"type":"object"}]}},"components/schemas/DocumentDescriptorUpdate":{"id":"components/schemas/DocumentDescriptorUpdate","kind":"json-schema","title":"DocumentDescriptorUpdate","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"$ref":"#/components/schemas/DocumentDescriptorFields"},{"properties":{"type":{"$ref":"#/components/schemas/DocumentType"}},"type":"object"}]}},"components/schemas/IdentityPaging":{"id":"components/schemas/IdentityPaging","kind":"json-schema","title":"IdentityPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Identity"},"type":"array"}},"type":"object"}]}},"components/schemas/LegalRepresentative":{"id":"components/schemas/LegalRepresentative","kind":"json-schema","title":"legalRepresentative","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":"Contains details about an entity that legally represents a borrower.\n","properties":{"address":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission the street-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressLine2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POBox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city, state, postal code, and country are retained."},"children":[]}]}]}]},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of a legal entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"j***@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]}],"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"object":{"default":"legalRepresentative","enum":["legalRepresentative"],"readOnly":true,"type":"string"},"otherEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional email address of a legal entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"j***@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]}],"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional phone number of a legal entity. This should be provided in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked to the last four digits (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"********1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"type":"string"},"phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number of a legal entity. This should be provided in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/E.164"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked to the last four digits (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"********1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for callers lacking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person:read.pii"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}],"type":"string"},"redactedFields":{"$ref":"#/components/schemas/RedactedFields"},"status":{"description":"Legal representative's status.","enum":["active","nonResponsive","inactive","archived"],"type":"string"},"statusUpdatedAt":{"description":"The time of status update.","format":"date-time","readOnly":true,"type":"string"},"validAddress":{"$ref":"#/components/schemas/ValidAddress"}},"type":"object"}],"title":"legalRepresentative"}},"components/schemas/LegalRepresentativesPaging":{"id":"components/schemas/LegalRepresentativesPaging","kind":"json-schema","title":"legalRepresentative","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"description":"Array of legal entities\n","items":{"$ref":"#/components/schemas/LegalRepresentative"},"type":"array"}},"type":"object"}],"title":"legalRepresentative"}},"components/schemas/NewInstallmentAtOriginationRequirements":{"id":"components/schemas/NewInstallmentAtOriginationRequirements","kind":"json-schema","title":"NewInstallmentAtOriginationRequirements","data":{"properties":{"atOrigination":{"required":["amountFinanced","duration","interestRates","paymentFrequency","originationLicense","originatingCreditorName"],"type":"object"}},"type":"object"}},"components/schemas/NewInstallment":{"id":"components/schemas/NewInstallment","kind":"json-schema","title":"Installment","data":{"allOf":[{"properties":{"timestamps":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The fields in this object will not affect the loan."},"children":[]}]}]}]},"type":{"enum":["installment"],"type":"string"}},"required":["loanTypeId","servicedBy","status"],"type":"object"},{"$ref":"#/components/schemas/Installment"},{"$ref":"#/components/schemas/NewInstallmentAtOriginationRequirements"}],"title":"Installment"}},"components/schemas/NewLineOfCreditAtOriginationRequirements":{"id":"components/schemas/NewLineOfCreditAtOriginationRequirements","kind":"json-schema","title":"NewLineOfCreditAtOriginationRequirements","data":{"properties":{"atOrigination":{"required":["creditLimitAmount","interestRates","paymentFrequency","originationLicense","originatingCreditorName"],"type":"object"}},"type":"object"}},"components/schemas/NewLineOfCredit":{"id":"components/schemas/NewLineOfCredit","kind":"json-schema","title":"Line of Credit","data":{"allOf":[{"properties":{"timestamps":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The fields in this object will not affect the loan."},"children":[]}]}]}]},"type":{"enum":["lineOfCredit"],"type":"string"}},"required":["loanTypeId","servicedBy","status"],"type":"object"},{"$ref":"#/components/schemas/LineOfCredit"},{"$ref":"#/components/schemas/NewLineOfCreditAtOriginationRequirements"}],"title":"Line of Credit"}},"components/schemas/NewLoan":{"id":"components/schemas/NewLoan","kind":"json-schema","title":"newLoan","data":{"anyOf":[{"$ref":"#/components/schemas/NewInstallment"},{"$ref":"#/components/schemas/NewLineOfCredit"}],"description":"Represents a loan. A loan always belongs to a borrower, and most of\nthe interactions between a lender and a borrower are associated with a\nparticular loan.\n","title":"newLoan"}},"components/schemas/LoanAccelerate":{"id":"components/schemas/LoanAccelerate","kind":"json-schema","title":"LoanAccelerate","data":{"allOf":[{"properties":{"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the loan acceleration. The date should be the current date in the product timezone."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will also set the field to today's date."},"children":[]}]}]}],"format":"date","type":"string"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanAccelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["effectiveDate"]}},"components/schemas/LoanAccelerateResponse":{"id":"components/schemas/LoanAccelerateResponse","kind":"json-schema","title":"LoanAccelerateResponse","data":{"properties":{"acceleratedAmount":{"description":"The amount accelerated.","format":"float","type":"number"}},"type":"object"}},"components/schemas/LoanActivate":{"id":"components/schemas/LoanActivate","kind":"json-schema","title":"LoanActivate","data":{"properties":{"amortizationAtActivation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instructions on how to activate a loan in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. The loan status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a successful activation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedPaymentsAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - we will use the exact "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due dates and amounts. The loan is not re-amortized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amortizeAtActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - we will re-amortize the loan using today's date as the loan start date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used to create due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.expectedPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due dates and amounts are not used."},"children":[]}]}]}],"enum":["expectedPaymentsAtOrigination","amortizeAtActivation"],"type":"string"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/ExpectedPayment":{"id":"components/schemas/ExpectedPayment","kind":"json-schema","title":"ExpectedPayment","data":{"properties":{"amount":{"description":"The amount of the expected payment.","format":"float","type":"number"},"date":{"description":"The due date of the expected payment.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this will contain details of the dynamic fee."},"children":[]}]}]}],"properties":{"apiName":{"description":"The API name of the dynamic fee. For example: 'lateFee' or 'breatherFee'.\n","type":"string"},"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the dynamic fee as shown to the borrower in the UI. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Late Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Breather Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"dynamicFeeTypeId":{"description":"The dynamic fee type identifier in the system.","type":"string"},"loanFeeId":{"description":"The loan fee identifier in the system.","type":"string"}},"type":"object"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"interestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"isDeferred":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the amount of this expected payment has been deferred before."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"isForcedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will honor the amount and will not update it on loan recalculations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the amount is less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system can increase the amount when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan is being recalculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most of the cases, the lender should set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka the default value.) If you need more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"explanation or advice on your use case, please contact the Peach team."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the expected payment at creation. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will change as a result of refreshing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expected payments, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will stay the same."},"children":[]}]}]}],"format":"float","type":"number"},"paymentType":{"description":"The payment type.","enum":["periodicPayment","originationFee","drawFee","dynamicFee","downPayment","discountCredit"],"type":"string"},"periodId":{"description":"The period identifier.","type":"string"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the expected payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  - borrower is expected to make the payment. Only applicable to paymentType=dynamicFee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower is or was expected to make the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the amount was modified at some point and different from the original amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower is or was not expected to make the payment."},"children":[]}]}]}],"enum":["booked","modified","canceled"],"type":"string"},"unroundedInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedInterestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount. Available only for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"},"unroundedPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal. Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is unrounded."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/LoanSchedule":{"id":"components/schemas/LoanSchedule","kind":"json-schema","title":"LoanSchedule","data":{"properties":{"schedule":{"items":{"$ref":"#/components/schemas/ExpectedPayment"},"type":"array"}},"type":"object"}},"components/schemas/LoanActivationResponse":{"id":"components/schemas/LoanActivationResponse","kind":"json-schema","title":"LoanActivationResponse","data":{"oneOf":[{"properties":{"amountsValidation":{"$ref":"#/components/schemas/AmountsValidation"},"ratesValidation":{"$ref":"#/components/schemas/RatesValidation"},"schedule":{"$ref":"#/components/schemas/LoanSchedule"}},"title":"Installment","type":"object"},{"properties":{"amountsValidation":{"$ref":"#/components/schemas/AmountsValidation"},"schedule":{"$ref":"#/components/schemas/LoanSchedule"}},"title":"Line of Credit","type":"object"}]}},"components/schemas/AutopayExpectedPayment":{"id":"components/schemas/AutopayExpectedPayment","kind":"json-schema","title":"AutopayExpectedPayment","data":{"properties":{"amount":{"description":"The amount of the expected payment.","format":"float","type":"number"},"date":{"description":"The due date of the expected payment.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this will contain details of the dynamic fee."},"children":[]}]}]}],"properties":{"apiName":{"description":"The API name of the dynamic fee. For example: 'lateFee' or 'breatherFee'.\n","type":"string"},"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the dynamic fee as shown to the borrower in the UI. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Late Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Breather Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"dynamicFeeTypeId":{"description":"The dynamic fee type identifier in the system.","type":"string"},"loanFeeId":{"description":"The loan fee identifier in the system.","type":"string"}},"type":"object"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to net interest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"interestBeforeDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest amount that was accrued before promo rate(s) or any discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"isDeferred":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the amount of this expected payment has been deferred before."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the expected payment at creation. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will change as a result of refreshing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expected payments, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will stay the same."},"children":[]}]}]}],"format":"float","type":"number"},"paymentType":{"description":"The payment type.","enum":["periodicPayment","originationFee","drawFee","dynamicFee","downPayment","discountCredit"],"type":"string"},"periodId":{"description":"The period identifier.","type":"string"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allocated to principal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType=periodicPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the expected payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower is or was expected to make the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the amount was modified at some point and different from the original amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower is or was not expected to make the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a payment has been scheduled for this expected payment."},"children":[]}]}]}],"enum":["booked","modified","canceled","processed"],"type":"string"}},"type":"object"}},"components/schemas/InstallmentAutopay":{"id":"components/schemas/InstallmentAutopay","kind":"json-schema","title":"Installment","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"properties":{"agreementDocumentId":{"description":"The document descriptor ID corresponding to the autopay agreement document.\n","type":"string"},"cancelReason":{"$ref":"#/components/schemas/AutopayCancelReason"},"createdAt":{"format":"date-time","type":"string"},"id":{"description":"The autopay identifier.","readOnly":true,"type":"string"},"paymentFrequency":{"description":"The Autopay payments frequency.","enum":["weekly","everyTwoWeeks","twiceMonthly","monthly"],"type":"string"},"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.\n","type":"string"},"schedule":{"items":{"$ref":"#/components/schemas/AutopayExpectedPayment"},"type":"array"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"type":"object"}],"title":"Installment"}},"components/schemas/LineOfCreditAutopay":{"id":"components/schemas/LineOfCreditAutopay","kind":"json-schema","title":"Line Of Credit","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"properties":{"agreementDocumentId":{"description":"The document descriptor ID corresponding to the autopay agreement document.\n","type":"string"},"cancelReason":{"description":"Why the transaction was canceled.","enum":["invalidPaymentMethod","paymentMethodRemoved","tooManyFailedAttempts","loanFrozen","loanAccelerated","loanChargedOff","loanPaidOff","canceledByUser","loanTermsChanged"],"nullable":true,"type":"string"},"createdAt":{"format":"date-time","type":"string"},"extraAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extra amount that the borrower agrees to pay if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=statementMinimumAmountPlusExtra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"id":{"description":"The autopay identifier.","readOnly":true,"type":"string"},"isAlignedToDueDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay transactions will be processed on the loan's due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay transactions schedule will be different from the loan's due dates schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlignedToDueDates=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"type":"boolean"},"offsetFromDueDate":{"items":{"type":"integer"},"nullable":true,"type":"array"},"paymentFrequency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Autopay payments frequency. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" frequency is not supported for line of credit."},"children":[]}]}]}],"enum":["twiceMonthly","everyTwoWeeks","monthly"],"type":"string"},"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.\n","type":"string"},"schedule":{"items":{"$ref":"#/components/schemas/AutopayExpectedPayment"},"type":"array"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how Autopay amount will be calculated for each closed statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementMinimumAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay will debit the statement minimum amount for the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementMinimumAmountPlusExtra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay will debit the statement minimum amount for the period plus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extra amount. The extra amount is typically applied to principal. This is ONLY applicable to non-amortized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"line of credit loans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay transaction will debit the statement balance for the period. This is ONLY applicable to non-amortized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"line of credit loans."},"children":[]}]}]}],"enum":["statementMinimumAmount","statementMinimumAmountPlusExtra","statementBalanceAmount"],"type":"string"}},"type":"object"}],"title":"Line Of Credit"}},"components/schemas/Autopay":{"id":"components/schemas/Autopay","kind":"json-schema","title":"Autopay","data":{"anyOf":[{"$ref":"#/components/schemas/InstallmentAutopay"},{"$ref":"#/components/schemas/LineOfCreditAutopay"}]}},"components/schemas/AutopayUpdate":{"id":"components/schemas/AutopayUpdate","kind":"json-schema","title":"AutopayUpdate","data":{"properties":{"agreementDocumentId":{"description":"The document ID for the signed autopay agreement. Required unless the payment instrument is external.\n","type":"string"},"caseId":{"description":"An identifier for an existing case.\n","type":"string"},"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.\n","type":"string"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayPaymentMethodUpdated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"required":["paymentInstrumentId"],"type":"object"}},"components/schemas/DeltaTerms":{"id":"components/schemas/DeltaTerms","kind":"json-schema","title":"DeltaTerms","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delta change in interest, fees, calendar days, and number of due dates. Only relevant for installment loans. For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non installment loans, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deltaTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields will be null."},"children":[]}]}]}],"properties":{"deltaTerms":{"properties":{"deltaDueDatesNumber":{"description":"A positive number indicates the number of additional due dates that were added to the loan schedule. A negative\nnumber indicates the number due dates that were removed from the loan schedule.\n","nullable":true,"type":"integer"},"deltaDurationDays":{"description":"A positive number indicates number of calendar days that the loan's term is extended as a result of the\nchange. A negative number indicates the number of calendar days that the loan's term is shortened as\na result of the change.\n","nullable":true,"type":"integer"},"deltaFeeAmount":{"description":"A positive amount indicates the additional fees that the borrower is expected to pay as a result of\nthe change. A negative amount indicates savings in fees the borrower is expected to benefit from as\na result of the change.\n","format":"float","nullable":true,"type":"number"},"deltaInterestAmount":{"description":"A positive amount indicates the additional interest that the borrower is expected to pay as a\nresult of the change. A negative amount indicates savings in interest the borrower is expected to\nbenefit from as a result of the change.\n","format":"float","nullable":true,"type":"number"}},"type":"object"}},"type":"object"}},"components/schemas/InstallmentAutopayPost":{"id":"components/schemas/InstallmentAutopayPost","kind":"json-schema","title":"Installment","data":{"properties":{"agreementDocumentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID for the signed autopay agreement. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"caseId":{"description":"An identifier for an existing case.\n","type":"string"},"isAlignedToDueDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay payments will be aligned and processed on the loan's due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay payments schedule will be different from the loan's due dates schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlignedToDueDates=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the frequency and specific days of autopay matches the loan, we assume that it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlignedToDueDates=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"paymentFrequency":{"description":"The Autopay payments frequency.","enum":["weekly","everyTwoWeeks","twiceMonthly","monthly"],"type":"string"},"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.\n","type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change, and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"required":["paymentInstrumentId"],"title":"Installment","type":"object"}},"components/schemas/LineOfCreditAutopayPost":{"id":"components/schemas/LineOfCreditAutopayPost","kind":"json-schema","title":"Line Of Credit","data":{"properties":{"agreementDocumentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID for the signed autopay agreement. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amountType":{"default":"statementMinimumAmount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how Autopay amount will be calculated for each closed statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementMinimumAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay will debit the statement minimum amount for the period. The statement minimum"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount is defined as the sum of the expected payment amounts in the given period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementMinimumAmountPlusExtra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay will debit the statement minimum amount for the period plus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extra amount. The extra amount is typically applied to principal. In any given autopay period, if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'statementMinimumAmountPlusExtra' is greater than the outstanding balance on the line of credit, we only debit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"up to the amount of the latter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an Autopay transaction will debit the statement balance as of the statement creation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date for the given period."},"children":[]}]}]}],"enum":["statementMinimumAmount","statementMinimumAmountPlusExtra","statementBalanceAmount"],"type":"string"},"caseId":{"description":"An identifier for an existing case.\n","type":"string"},"extraAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extra amount that the borrower agrees to pay if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=statementMinimumAmountPlusExtra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"isAlignedToDueDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay transactions will be processed on the loan's due dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the Autopay transactions schedule will be different from the loan's due dates schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlignedToDueDates=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offsetFromDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"type":"boolean"},"offsetFromDueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of calendars days before due dates when Autopay payments are processed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlignedToDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false, it is required to specify the offset from the due dates. Depending on whether there are 1 or 2 auto-payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per period, the array should include either 1 or 2 integers."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onceAPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower can choose X days before the due date. Provide one number in a valid range between \"1\" and \"statement to due date\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days (e.g. 14 or 21). For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[5]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the Autopay will be processed 5 calendar days before a given due date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceAPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - borrower can choose two offsets, in other words, Autopay will process half the amount on the first Autopay date, and half"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the amount on the second Autopay date. Both days are \"offsets\", with \"0\" meaning on the due date. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[5, 0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the first Autopay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment will be scheduled and processed 5 days before the due date, and the second Autopay payment will be scheduled and processed on the due date."},"children":[]}]}]}]}],"items":{"type":"integer"},"nullable":true,"type":"array"},"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.\n","type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"required":["paymentInstrumentId"],"title":"Line Of Credit","type":"object"}},"components/schemas/AutopayPost":{"id":"components/schemas/AutopayPost","kind":"json-schema","title":"AutopayPost","data":{"anyOf":[{"$ref":"#/components/schemas/InstallmentAutopayPost"},{"$ref":"#/components/schemas/LineOfCreditAutopayPost"}]}},"components/schemas/LoanCancelMetro2RequestBody":{"id":"components/schemas/LoanCancelMetro2RequestBody","kind":"json-schema","title":"LoanCancelMetro2RequestBody","data":{"properties":{"accountStatusCode":{"default":"DA","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Metro2 Account Status that will be reported to credit agencies upon loan cancellation or deletion. Make sure you follow the Metro2 Credit Reporting Resource Guide."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following statuses were copied from the Metro2 Guide. The list below is a subset of account status codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Paid or closed account/zero balance. For Installment and Mortgage loans, the account should be paid with a zero Balance Amount. For Credit Line, Open and Revolving portfolio types, the account should no longer be available for use, and the Balance Amount should be zero. A Special Comment Code M or Compliance Condition Code XA may also be reported to indicate the account is closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"61"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account paid in full, was a voluntary surrender. Requires Current Balance and Amount Past Due = zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"62"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account paid in full, was a collection account. Requires Current Balance and Amount Past Due = zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"63"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account paid in full, was a repossession. Requires Current Balance and Amount Past Due = zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"93"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account assigned to internal or external collections."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"95"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Voluntary surrender; there may be a balance due."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"96"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Merchandise was repossessed; there may be a balance due."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"97"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unpaid balance reported as a loss (charge-off)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delete entire account (for reasons other than fraud)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delete entire account due to confirmed fraud (fraud investigation completed)."},"children":[]}]}]}]}],"enum":["13","61","62","63","93","95","96","97","DA","DF"],"type":"string"}},"type":"object"}},"components/schemas/LoanCancel":{"id":"components/schemas/LoanCancel","kind":"json-schema","title":"LoanCancel","data":{"allOf":[{"properties":{"cancellationReason":{"$ref":"#/components/schemas/CancellationReason"},"metro2":{"$ref":"#/components/schemas/LoanCancelMetro2RequestBody"},"sendCancellationNotice":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanCanceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"components/schemas/CardBaseData":{"id":"components/schemas/CardBaseData","kind":"json-schema","title":"CardBaseData","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"externalId":{"description":"A lender's unique identifier for a specific promotional program type.","type":"string"},"galileoCad":{"description":"Galileo-generated identifier for a specific card.\n","type":"string"},"galileoPrn":{"description":"Unique 12-digit Galileo-generated account identifier.\n","type":"string"},"isExternal":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), Peach does not interact with the card directly; the object is for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visualization/filter purposes only. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach will call out to / receive events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the external card system (e.g. Lithic) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the issuer-specific card"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token field (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marqetaCardToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lithicCardToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"galileoCad"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are required."},"children":[]}]}]}],"type":"boolean"},"issuerId":{"description":"The card issuer/vendor unique identifier. The card issuer must be configured in Peach.","type":"string"},"lithicAccountToken":{"description":"Lithic-generated identifier for an account holder (consumer or business).\n","type":"string"},"lithicCardToken":{"description":"Lithic-generated identifier for a specific card product.\n","type":"string"},"marqetaBusinessToken":{"description":"Marqeta-generated identifier for a specific business.\n","type":"string"},"marqetaCardProductToken":{"description":"Marqeta-generated identifier for a specific card product.\n","type":"string"},"marqetaCardToken":{"description":"Lender or Marqeta-generated unique identifier for the card.\n","type":"string"},"marqetaUserToken":{"description":"Marqeta-generated identifier for a specific user.\n","type":"string"},"status":{"default":"active","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender-owned status of the card. Peach does not auto-update this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from issuer webhooks. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on creation if not provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is separate from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardDetails.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which reflects the issuer-driven"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"internal status."},"children":[]}]}]}],"enum":["active","inactive","blocked","closed","expired"],"type":"string"}},"type":"object"}]}},"components/schemas/CardDetails":{"id":"components/schemas/CardDetails","kind":"json-schema","title":"CardDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card details. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field here reflects the issuer-driven internal status. Prefer the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the lender-owned status."},"children":[]}]}]}],"properties":{"address":{"$ref":"#/components/schemas/Address","description":"The billing address associated with the card. Must have at least postal code."},"cardNumberLastFour":{"description":"The last four digits of the card number.","type":"string"},"expirationMonth":{"description":"The expiration month of the card.","example":12,"maximum":12,"minimum":1,"type":"integer"},"expirationYear":{"description":"The expiration year of the card.","example":2025,"type":"integer"},"firstName":{"description":"First name on the card.","type":"string"},"fulfillmentStatus":{"description":"The fulfillment status of the card.","enum":["issued","ordered","rejected","shipped","digitallyPresented"],"type":"string"},"lastName":{"description":"Last name on the card.","type":"string"},"network":{"description":"The card network.","enum":["visa","mastercard","discover","americanExpress"],"type":"string"},"nickname":{"description":"Nickname for card, typically decided by consumer","nullable":true,"type":"string"},"status":{"description":"The issuer-driven internal status of the card.","enum":["inactive","pendingActivation","pendingFulfillment","active","paused","suspended","terminated","canceled","expired","invalid"],"type":"string"},"usageType":{"description":"The type of allowable usage for the card.","enum":["singleUse","merchantLocked","digitalWallet","unlocked","physical"],"type":"string"}},"type":"object"}},"components/schemas/BaseCard":{"id":"components/schemas/BaseCard","kind":"json-schema","title":"Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/CardBaseData"},{"properties":{"cardDetails":{"$ref":"#/components/schemas/CardDetails"}},"type":"object"}],"title":"Card"}},"components/schemas/VirtualCardProperties":{"id":"components/schemas/VirtualCardProperties","kind":"json-schema","title":"VirtualCardProperties","data":{"properties":{"cardBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card balances. Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtualCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type card objects."},"children":[]}]}]}],"properties":{"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original amount of the card before it was used. If null, will default to the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.amountFinanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"refundedAmount":{"description":"The amount of the card that was refunded back to the card or otherwise not used.\n","format":"float","nullable":true,"readOnly":true,"type":"number"},"usedAmount":{"description":"The amount of the card that was used.\n","format":"float","nullable":true,"readOnly":true,"type":"number"}},"type":"object"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of card issued. For loanType "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"installment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the only allowable value is virtualCard."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For loanType "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineOfCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", virtual and credit card are accepted."},"children":[]}]}]}],"enum":["virtualCard"],"type":"string"}},"type":"object"}},"components/schemas/VirtualCard":{"id":"components/schemas/VirtualCard","kind":"json-schema","title":"Virtual card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCard"},{"$ref":"#/components/schemas/VirtualCardProperties"}],"title":"Virtual card"}},"components/schemas/CreditCardProperties":{"id":"components/schemas/CreditCardProperties","kind":"json-schema","title":"CreditCardProperties","data":{"properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of card issued. For loanType "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"installment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the only allowable value is virtualCard."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For loanType "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineOfCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", virtual and credit card are accepted."},"children":[]}]}]}],"enum":["creditCard"],"type":"string"},"usageRestrictions":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional usage restrictions of the specific card to apply to purchases. These will be applied in addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageRestrictions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created in the program object as part of the card issuer APIs."},"children":[]}]}]}]},{"$ref":"#/components/schemas/UsageRestrictions"}]}},"type":"object"}},"components/schemas/CreditCard":{"id":"components/schemas/CreditCard","kind":"json-schema","title":"Credit card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCard"},{"$ref":"#/components/schemas/CreditCardProperties"}],"title":"Credit card"}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"anyOf":[{"$ref":"#/components/schemas/VirtualCard"},{"$ref":"#/components/schemas/CreditCard"}]}},"components/schemas/CardDetailsWithPanAndCvv":{"id":"components/schemas/CardDetailsWithPanAndCvv","kind":"json-schema","title":"CardDetailsWithPanAndCvv","data":{"allOf":[{"$ref":"#/components/schemas/CardDetails"},{"properties":{"cvvNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full CVV2 number. Only included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"showCvv=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"type":"string"},"pan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card full PAN. Only included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"showPan=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}]}},"components/schemas/BaseCardWithPanAndCvv":{"id":"components/schemas/BaseCardWithPanAndCvv","kind":"json-schema","title":"Card","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/CardBaseData"},{"properties":{"cardDetails":{"$ref":"#/components/schemas/CardDetailsWithPanAndCvv"}},"type":"object"}],"title":"Card"}},"components/schemas/VirtualCardWithPanAndCvv":{"id":"components/schemas/VirtualCardWithPanAndCvv","kind":"json-schema","title":"Virtual card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardWithPanAndCvv"},{"$ref":"#/components/schemas/VirtualCardProperties"}],"title":"Virtual card"}},"components/schemas/CreditCardWithPanAndCvv":{"id":"components/schemas/CreditCardWithPanAndCvv","kind":"json-schema","title":"Credit card","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardWithPanAndCvv"},{"$ref":"#/components/schemas/CreditCardProperties"}],"title":"Credit card"}},"components/schemas/CardWithPanAndCvv":{"id":"components/schemas/CardWithPanAndCvv","kind":"json-schema","title":"CardWithPanAndCvv","data":{"anyOf":[{"$ref":"#/components/schemas/VirtualCardWithPanAndCvv"},{"$ref":"#/components/schemas/CreditCardWithPanAndCvv"}]}},"components/schemas/CardStatusChangeReasonCode":{"id":"components/schemas/CardStatusChangeReasonCode","kind":"json-schema","title":"CardStatusChangeReasonCode","data":{"properties":{"statusChangeReasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason a card's status is being updated. Please see table below for allowable statuses based on reason code."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach Card Status Change Reason Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowable Peach Card Status"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardCanceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardExpired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expired"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardInvalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardClosed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardDamaged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardFraudulent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paused"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardInactive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inactive"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardLost"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paused"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardPFraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paused"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardSuspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspended"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardUnauthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardAcceptorActivityQuestionable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paused"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardStolen"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminated"},"children":[]}]}]}]}]}]}],"enum":["cardCanceled","cardExpired","cardInvalid","cardClosed","cardDamaged","cardFraudulent","cardInactive","cardLost","cardPFraud","cardSuspended","cardUnauthorized","cardAcceptorActivityQuestionable","cardStolen"],"type":"string"}},"type":"object"}},"components/schemas/PutCardWithPanAndCvv":{"id":"components/schemas/PutCardWithPanAndCvv","kind":"json-schema","title":"PutCardWithPanAndCvv","data":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/VirtualCardWithPanAndCvv"},{"$ref":"#/components/schemas/CardStatusChangeReasonCode"}],"title":"Virtual card"},{"allOf":[{"$ref":"#/components/schemas/CreditCardWithPanAndCvv"},{"$ref":"#/components/schemas/CardStatusChangeReasonCode"}],"title":"Credit card"}]}},"components/schemas/LoanChargeOff":{"id":"components/schemas/LoanChargeOff","kind":"json-schema","title":"LoanChargeOff","data":{"allOf":[{"properties":{"chargedOffReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for loan charge off:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off per loan type configuration after X days overdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudulent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off for fraudulent reason. If the loan is reported to one or more credit bureaus, the system will automatically send a special request to each bureau to delete the tradeline due to confirmed fraud. This is the only reason that the system will automatically trigger a request to delete the tradeline. For other reasons, if you need to delete the tradeline please call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delete from credit reporting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or use an agent tool."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of bankruptcy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of some legal reason."},"children":[]}]}]}],"enum":["term","fraudulent","bankruptcy","legal"],"type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the loan charge-off. The date should be the current date in the product timezone."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"today\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will also set the field to today's date."},"children":[]}]}]}],"format":"date","type":"string"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffReason=term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of the following reasons [fraudulent, bankruptcy, legal], the system will ignore the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value and will NOT send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanChargedOffUnsecured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffReason=term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the passed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanChargedOffUnsecured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["effectiveDate","chargedOffReason"]}},"components/schemas/LoanChargeOffResponse":{"id":"components/schemas/LoanChargeOffResponse","kind":"json-schema","title":"LoanChargeOffResponse","data":{"properties":{"chargeOffAmount":{"description":"The amount charged-off.","format":"float","type":"number"}},"type":"object"}},"components/schemas/CollectionAgencyLoanDetailsBase":{"id":"components/schemas/CollectionAgencyLoanDetailsBase","kind":"json-schema","title":"CollectionAgencyLoanDetailsBase","data":{"properties":{"agencyExternalId":{"description":"The lender's external identifier for the agency.","readOnly":true,"type":"string"},"assignedOnDate":{"description":"The date when the loan was assigned to a debt collection agency. If a date is not passed, the system will set the date to today.\n","format":"date","nullable":true,"type":"string"},"assignmentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of loan assignment to a debt collection agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholeSale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The loan was sold to a third party debt collections"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"agency. The loan is no longer managed by Peach as the system of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contingency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Collection efforts are performed by a third party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debt collections agency. The loan is still managed by Peach as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system of record."},"children":[]}]}]}],"enum":["wholeSale","contingency"],"nullable":false,"type":"string"},"metro2":{"properties":{"reportK2Segment":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to loans that are reported to credit bureaus."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will report the K2 segment in the Metro2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file to indicate that the loan has been sold to a third party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debt collections agency. The Peach system will report the loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the final time in the period the loan is assigned to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collections agency. After that, Peach will not report the loan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"again; it is the new collection agency's responsibility to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handle all future reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will not report the K2 segment in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metro2 file. Peach will continue to report the loan."},"children":[]}]}]}],"nullable":false,"type":"boolean"}},"type":"object"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pendingAssignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan is in the process of being assigned to an agency. It might take a few days for the agency to be ready to start collecting debt. Peach cannot collect payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assigned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the loan was successfully assigned to an agency. The borrower should contact the agency for details. Peach cannot collect payments and loan balances might not be accurate."},"children":[]}]}]}],"enum":["unassigned","pendingAssignment","assigned"],"type":"string"}},"type":"object"}},"components/schemas/CollectionAgencyLoanDetailsGet":{"id":"components/schemas/CollectionAgencyLoanDetailsGet","kind":"json-schema","title":"CollectionAgencyLoanDetailsGet","data":{"allOf":[{"properties":{"agencyId":{"description":"The agency's unique identifier.\n","readOnly":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CollectionAgencyLoanDetailsBase"}]}},"components/schemas/CollectionAgencyLoanDetailsPut":{"id":"components/schemas/CollectionAgencyLoanDetailsPut","kind":"json-schema","title":"CollectionAgencyLoanDetailsPut","data":{"allOf":[{"properties":{"agencyId":{"$ref":"#/components/schemas/AnyId","description":"The agency's unique identifier, internal or lender's external.\n","writeOnly":true}},"type":"object"},{"$ref":"#/components/schemas/CollectionAgencyLoanDetailsBase"}]}},"components/schemas/CreditLimitProperties":{"id":"components/schemas/CreditLimitProperties","kind":"json-schema","title":"CreditLimitProperties","data":{"allOf":[{"properties":{"adverseActionReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the credit limit was changed. If passed, the copy used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locCreditLimitChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" communication"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"template. Make sure to phrase the copy as a full sentence or paragraph."},"children":[]}]}]}],"type":"string"},"creditLimitAmount":{"description":"The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n","format":"float","type":"number"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the system sent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locCreditLimitChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"required":["creditLimitAmount"],"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"components/schemas/CreditReportingStatusBase":{"id":"components/schemas/CreditReportingStatusBase","kind":"json-schema","title":"CreditReportingStatusBase","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"accountStatusCode":{"description":"The metro2 account status code. This is a 2 digit code that indicates the status of the account.\nThis is given by the lender in either in loan cancelation or opting a loan out of credit reporting.\n","readOnly":true,"type":"string"},"loanId":{"description":"The unique loan identifier.","readOnly":true,"type":"string"}},"type":"object"}]}},"components/schemas/StartCreditReporting":{"id":"components/schemas/StartCreditReporting","kind":"json-schema","title":"StartCreditReporting","data":{"allOf":[{"$ref":"#/components/schemas/CreditReportingStatusBase"},{"properties":{"creditAgencyId":{"description":"The unique credit agency identifier.","type":"string"},"reportingStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a new loan is created the system automatically starts reporting to all agencies that are configured in the loan type configuration. In that case the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportingStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be equal to the loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an existing loans (aka loan in flight) needs to be reported, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportingStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates how much of the loan's history should be reported. If a full history needs to be reported, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportingStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be equal to loan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"}]}},"components/schemas/DeleteCreditReporting":{"id":"components/schemas/DeleteCreditReporting","kind":"json-schema","title":"DeleteCreditReporting","data":{"allOf":[{"$ref":"#/components/schemas/CreditReportingStatusBase"},{"properties":{"caseId":{"description":"An identifier for an existing case.","nullable":true,"type":"string","writeOnly":true},"deletedReason":{"description":"The reason why the loan was stopped from being reported.\n","enum":["legal","fcraDispute","loanDataCorrupted","fraudulent","other"],"type":"string"},"deletedReasonDetails":{"description":"Additional details about why the loan was stopped from being reported.\n","type":"string"},"metro2":{"$ref":"#/components/schemas/LoanCancelMetro2RequestBody"},"reportingEndDate":{"description":"This attribute has a value (date) if the loan needs to be deleted or was already deleted from being reported to the credit agency.\n\nOnce the loan is deleted, it cannot be reported again.\n","format":"date","readOnly":true,"type":"string"}},"type":"object"}]}},"components/schemas/CreditReportingStatus":{"id":"components/schemas/CreditReportingStatus","kind":"json-schema","title":"Credit Reporting Status","data":{"allOf":[{"$ref":"#/components/schemas/StartCreditReporting"},{"$ref":"#/components/schemas/DeleteCreditReporting"}],"title":"Credit Reporting Status"}},"components/schemas/LoanCreditReportingFields":{"id":"components/schemas/LoanCreditReportingFields","kind":"json-schema","title":"LoanCreditReportingFields","data":{"properties":{"metro2":{"properties":{"complianceConditionCode":{"description":"Compliance condition code that if set will be reported to credit agencies. This value will override any other value currently reported in the Special Comment field in the Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n","maxLength":2,"type":"string"},"ecoaCodeBaseSegment":{"description":"ECOA code that if set will be reported to credit agencies. This value will override any other value currently reported in the ECOA Code field in Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n","maxLength":1,"type":"string"},"specialCommentBaseSegment":{"description":"Special comment code that if set will be reported to credit agencies. This value will override any other value currently reported in the Special Comment field in the Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n","maxLength":2,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/customPaymentPlanAmount":{"id":"components/schemas/customPaymentPlanAmount","kind":"json-schema","title":"customPaymentPlanAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount required to be fulfilled for each payment plan period. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided should be the recurring amount rather than the total amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the plan. Peach's system will use the amount provided to determine whether the borrower is past due and report to bureaus accordingly (if applicable)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Any fees added during the duration of the payment plan must also be paid in order for the borrower to remain \"current\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be higher or lower than the borrower's originally contracted amount. Peach's system will revert to the recurring amount after the payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan end date if the loan still has a balance at the end of the payment plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not pass this attribute if the payment plan type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAndFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/customPaymentPlanCancellationReason":{"id":"components/schemas/customPaymentPlanCancellationReason","kind":"json-schema","title":"customPaymentPlanCancellationReason","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceledByUser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment plan was canceled by an agent or borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanTermsChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan terms changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanChargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was charged off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanAccelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was accelerated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPaymentPlanOffered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - another payment plan was offered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - for any other reason requiring cancellation."},"children":[]}]}]}],"enum":["canceledByUser","loanTermsChanged","loanChargedOff","loanAccelerated","otherPaymentPlanOffered","other"],"type":"string"}},"components/schemas/customPaymentPlanExternalId":{"id":"components/schemas/customPaymentPlanExternalId","kind":"json-schema","title":"customPaymentPlanExternalId","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for a payment pay plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"type":"string"}},"components/schemas/customPaymentPlanIsExtendLoanDuration":{"id":"components/schemas/customPaymentPlanIsExtendLoanDuration","kind":"json-schema","title":"customPaymentPlanIsExtendLoanDuration","data":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system may adjust and increase the loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" beyond the current end date to accommodate the payment plan. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system will not add additional periods beyond the current loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"components/schemas/customPaymentPlanNumberOfPeriods":{"id":"components/schemas/customPaymentPlanNumberOfPeriods","kind":"json-schema","title":"customPaymentPlanNumberOfPeriods","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods during which the payment plan terms are effective. Represented as the number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods. The system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"begin counting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the period represented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment plan must take place within the existing loan duration. Moreover, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExtendLoanDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must end on or before the last period of the loan. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExtendLoanDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan must end on or before the second to last payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the payment plan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency=weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods=6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the remaining loan duration is 12, the payment plan will be created with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 weeks duration during which the designated payment plan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in effect. Any subsequent periods after the payment plan has ended will revert"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the original periodic payment amount."},"children":[]}]}]}],"type":"integer"}},"components/schemas/customPaymentPlanType":{"id":"components/schemas/customPaymentPlanType","kind":"json-schema","title":"customPaymentPlanType","data":{"default":"fixedAmountAndFees","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how the system will calculate payment plan payments during the payment plan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixedAmountAndFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment plan payment amounts will be set as a recurring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that any configured recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fees (e.g. service fees) will also be included in the payment plan amount unless explicitly canceled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the time of payment plan creation when using this option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAndFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the payment plan amounts will be calculated by Peach's system as \"interest only\". Note that any configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring fees (e.g. service fees) will also be included in the payment plan amount unless explicitly canceled. Do not pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when using this option."},"children":[]}]}]}],"enum":["fixedAmountAndFees","interestAndFees"],"type":"string"}},"components/schemas/customPaymentPlanReasonDetails":{"id":"components/schemas/customPaymentPlanReasonDetails","kind":"json-schema","title":"customPaymentPlanReasonDetails","data":{"description":"The reason for payment plan cancellation. This is typically entered by an agent canceling a payment plan via the front end.\n","type":"string"}},"components/schemas/customPaymentPlanSelectedDueDate":{"id":"components/schemas/customPaymentPlanSelectedDueDate","kind":"json-schema","title":"customPaymentPlanSelectedDueDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The due date of the period from which to begin the payment plan. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided upon payment plan creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will use the current period due date as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it must be for a due date in the future."},"children":[]}]}]}],"format":"date","type":"string"}},"components/schemas/CustomPaymentPlanResult":{"id":"components/schemas/CustomPaymentPlanResult","kind":"json-schema","title":"CustomPaymentPlanResult","data":{"allOf":[{"properties":{"amount":{"$ref":"#/components/schemas/customPaymentPlanAmount"},"canceledBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who canceled the payment plan."},"children":[]}]}]}],"type":"string"},"cancellationCaseId":{"description":"An identifier for an existing case.","type":"string"},"cancellationReason":{"$ref":"#/components/schemas/customPaymentPlanCancellationReason"},"createdBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the payment plan."},"children":[]}]}]}],"type":"string"},"creationCaseId":{"description":"An identifier for an existing case.","type":"string"},"externalId":{"$ref":"#/components/schemas/customPaymentPlanExternalId"},"id":{"readOnly":true,"type":"string"},"isExtendLoanDuration":{"$ref":"#/components/schemas/customPaymentPlanIsExtendLoanDuration"},"numberOfPeriods":{"$ref":"#/components/schemas/customPaymentPlanNumberOfPeriods"},"paymentPlanType":{"$ref":"#/components/schemas/customPaymentPlanType"},"reasonDetails":{"$ref":"#/components/schemas/customPaymentPlanReasonDetails"},"schedule":{"items":{"$ref":"#/components/schemas/ExpectedPayment"},"type":"array"},"selectedDueDate":{"$ref":"#/components/schemas/customPaymentPlanSelectedDueDate"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment plan status. Once a payment plan is created, it is, by definition, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"periods in a payment plan period have passed, it will change status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If a payment plan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is canceled, it will change status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","inactive","canceled"],"type":"string"},"timestamps":{"properties":{"canceledAt":{"format":"date-time","readOnly":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}]}},"components/schemas/SendNoticeCancelAutopay":{"id":"components/schemas/SendNoticeCancelAutopay","kind":"json-schema","title":"SendNoticeCancelAutopay","data":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanPaymentScheduleChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Changing the loan terms will automatically cancel an existing Autopay (if enabled). A borrower,  an agent or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API caller needs to turn on / enable a new Autopay plan after the loan terms change is completed. If the loan has Autopay enabled:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autopayCanceledBySystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice in addition to the applicable loan terms notice."},"children":[]}]}]}]}],"type":"boolean"}},"components/schemas/LoanCustomPaymentPlan":{"id":"components/schemas/LoanCustomPaymentPlan","kind":"json-schema","title":"LoanCustomPaymentPlan","data":{"properties":{"amount":{"$ref":"#/components/schemas/customPaymentPlanAmount"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"externalId":{"$ref":"#/components/schemas/customPaymentPlanExternalId"},"isExtendLoanDuration":{"$ref":"#/components/schemas/customPaymentPlanIsExtendLoanDuration"},"numberOfPeriods":{"$ref":"#/components/schemas/customPaymentPlanNumberOfPeriods"},"paymentPlanType":{"$ref":"#/components/schemas/customPaymentPlanType"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change, and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"selectedDueDate":{"$ref":"#/components/schemas/customPaymentPlanSelectedDueDate"},"sendNotice":{"$ref":"#/components/schemas/SendNoticeCancelAutopay"}},"required":["numberOfPeriods"],"type":"object"}},"components/schemas/LoanCustomPaymentPlanCancel":{"id":"components/schemas/LoanCustomPaymentPlanCancel","kind":"json-schema","title":"LoanCustomPaymentPlanCancel","data":{"properties":{"cancellationReason":{"$ref":"#/components/schemas/customPaymentPlanCancellationReason"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"reasonDetails":{"$ref":"#/components/schemas/customPaymentPlanReasonDetails"},"sendNotice":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanPaymentScheduleChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"required":["cancellationReason"],"type":"object"}},"components/schemas/LoanDeferDueDate":{"id":"components/schemas/LoanDeferDueDate","kind":"json-schema","title":"LoanDeferDueDate","data":{"allOf":[{"properties":{"addAfterLastDueDate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move the new due date to a date after the last due date. The date will be calculated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based upon the existing loan cadence. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field should be left empty if utilizing this option."},"children":[]}]}]}],"type":"boolean"},"agreementDocumentId":{"description":"The document descriptor ID corresponding to the accepted loan term change agreement.\n","type":"string"},"newDueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The proposed new due date, chosen from an existing due date after the selected date. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addAfterLastDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field should be toggled to false if utilizing this option."},"children":[]}]}]}],"format":"date","type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"selectedDueDate":{"description":"The selected due date to defer. It can be the due date of the current period or a future due date in the loan schedule.\n","format":"date","type":"string"},"sendNotice":{"$ref":"#/components/schemas/SendNoticeCancelAutopay"},"waiveFee":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge a fee for deferral of a due date. The fee amount is defined as part of the loan type."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["selectedDueDate"]}},"components/schemas/DueDateDeferralFeeAmount":{"id":"components/schemas/DueDateDeferralFeeAmount","kind":"json-schema","title":"DueDateDeferralFeeAmount","data":{"properties":{"dueDateDeferralFeeAmount":{"description":"The due date deferral fee amount","type":"integer"}},"type":"object"}},"components/schemas/LoanDeferSchedule":{"id":"components/schemas/LoanDeferSchedule","kind":"json-schema","title":"LoanDeferSchedule","data":{"allOf":[{"properties":{"agreementDocumentId":{"description":"The document descriptor ID corresponding to the accepted loan term change agreement.\n","type":"string"},"bufferToPushOutSchedule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When deferring during the first period, this represents the number of calendar days that will be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"today's date. The resulting date will be used to push out due dates (today's date + buffer days). Interest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will continue to accrue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When deferring after the first period, we defer all due dates that fall between \"today's date\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and \"today's date + buffer days\" to the end of the loan one by one. If the current date falls on a due date,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it will not be deferred as the period has ended."},"children":[]}]}]}],"nullable":true,"type":"integer"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"$ref":"#/components/schemas/SendNoticeCancelAutopay"},"waiveFee":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge a deferral fee. The fee amount is defined as part of the loan type."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["bufferToPushOutSchedule"]}},"components/schemas/CreditLimitPercentage":{"id":"components/schemas/CreditLimitPercentage","kind":"json-schema","title":"CreditLimitPercentage","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw's credit limit as a percentage of the loan's credit limit. Lenders can set and update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditLimitPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both. If both values are set, the system will use the lower value. The format is decimal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, 0.01 is a 1%, 0.2 is a 20%."},"children":[]}]}]}],"format":"float","type":"number"}},"components/schemas/MinPaymentCalculation":{"id":"components/schemas/MinPaymentCalculation","kind":"json-schema","title":"MinPaymentCalculation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logic to calculate the minimum payment amount when a statement is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All interest accrued in the period and fees are always part of the minimum payment amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOverLimitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the minimum payment amount will include the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over limit amount at the time of statement generation as part of the required minimum payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", lenders can also control what percentage of the outstanding principal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be added to the minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement logic adds up all draws calculated minimum payment amounts and sets the total as the statement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum amount. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.statement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is configured such that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOverdueAmountInMinPayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the statement minimum payment amount will include the loan/line overdue amount as part of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the required minimum payment on the statement."},"children":[]}]}]}],"properties":{"includeOverLimitAmount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system first calculates the draw minimum amount, which includes accrued interest,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fees and some percentage of the outstanding principal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOverLimitAmount=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system would add an over limit amount to the minimum amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The over limit amount is calculated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max(utilizationAmount - creditLimitAmount, 0)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at the time of statement generation."},"children":[]}]}]}],"type":"boolean"},"minAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum periodic amount. For example: $15.00. The minimum will be only enforced if the draw doesn't have an amortized amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum will not be enforced if the principal of the draw is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outstanding draw principal is $100.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal=0.01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka 1%)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rate is 2% per month."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount=15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest amount per month is: $100.00 * 2% = $2.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum amount is: $2 + $100.00 * 1% = $3.00."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum payment will be set to $15.00 and not $3.00. The split between principal and interest will be: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest=$2.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal=$13.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"minInterestChargeAmount":{"default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum amount of interest charged in a period. If the draw has accrued interest in a billing period, but the amount calculated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minInterestChargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will add additional interest amount to the draw's interest bucket to equal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minInterestChargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"percentageOfPrincipal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of draw's outstanding principal and/or membership fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(if applicable)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The range is 0-1."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is decimal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, 0.01 is a 1%, 0.2 is a 20%."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-amortized draw or amortized draws for which the amortization"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term expires, the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculate the portion of principal and membership fee (if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable) for minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For amortized draws within the amortization term, the system will use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate membership fee only (if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable) for minimum amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion is taken from the expected payments (aka"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amortized amount)."},"children":[]}]}]}],"format":"float","maximum":1,"minimum":0,"type":"number"}},"type":"object"}},"components/schemas/RateCapsAtOriginationDraw":{"id":"components/schemas/RateCapsAtOriginationDraw","kind":"json-schema","title":"Rate Caps At Origination","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate caps that should apply to the draw at origination."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a new Draw:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.rateCaps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided or null, copy the Line of Credit's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate caps (if they exist)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.rateCaps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, create the specified rate caps and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignore the Line of Credit's existing rate caps."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.rateCaps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an empty list, neither copy nor create any rate caps"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a Draw is created, it manages its own Rate Caps independently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any updates to the Line of Credit's Rate Caps will not affect the Draw, and vice versa."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/RateCapAtOrigination"},"nullable":true,"title":"Rate Caps At Origination","type":"array"}},"components/schemas/DrawAtOrigination":{"id":"components/schemas/DrawAtOrigination","kind":"json-schema","title":"DrawAtOrigination","data":{"description":"This object contains loan details and terms as they were shown to a borrower at origination.\n","properties":{"aprEffective":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and show them as the APR (for example, on the statement.)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"aprNominal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nominal APR of the loan at origination. Pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprNominal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aprEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" even if they are equal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and show them as the APR (for example, on the statement.)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"autoAmortization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draws can be automatically amortized based on lender needs. Amortization of the draw allows borrowers to pay it back over a longer period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of time. If the draw is not amortized, the minimum amount due will be calculated based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minPaymentCalculation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will automatically amortize the draw only ONCE in the first period in which a purchase was ever made. If more purchases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"were made in the following periods, the system will NOT automatically re-amortize the draw. If you need to re-amortized the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amortize draw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the loan type is configured to accrue interest as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accrualMethod=compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there is a known limitation to the draw amortization"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculation logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw amortization calculation will be done using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method and not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compoundWithFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To ensure that the system calculates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest accurately, amortized draws should NOT include any fees."},"children":[]}]}]}]}],"properties":{"amortizationLogic":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amortizeAfterEachPurchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - indicates whether the system needs to amortize and re-amortize the draw when a new purchase is posted over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"periods. If no new purchases were posted, the system will not re-amortize the draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aggregatePurchasesInPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - indicates whether new purchases during a period should be \"aggregated\", added to outstanding draw principal and amortized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods automatically when the period ends. If no purchases were posted in a period, the system will not re-amortize the draw."},"children":[]}]}]}]}],"enum":["amortizeAfterEachPurchase","aggregatePurchasesInPeriod"],"type":"string"},"amortizationMethod":{"default":"equalPayments","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equalPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal (except maybe for the last payment)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most installment loans are expected to use this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will amortize the loan or draw making recurring payments equal to interest only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the last payment will include the entire principal. Keep in mind that if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interest.periodAccrualDurationType=actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the recurring payment amounts will be different every period for monthly and twice monthly frequencies. This is because a month"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can have 28, 29, 30 or 31 days and interest accrued will vary based on the number of days in the month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are additional limitations to be aware for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestPaymentsBalloonPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For installment loans, Autopay can only be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aligned to due dates. It means that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay.allowedFrequency.isDueDatesAvailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This way the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will only allow Autopay to be aligned to the loan frequency and due dates."},"children":[]}]}]}],"enum":["equalPayments","interestPaymentsBalloonPrincipal","custom"],"readOnly":true,"type":"string"},"duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the draw as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods of the line of credit. Only applicable if the draw needs to be amortized. Pass one of the values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"periodicPaymentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring payment amount. The system will calculate the needed duration. Pass one of the values only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodicPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"required":["amortizationLogic"],"type":"object"},"creditLimitAmount":{"description":"The credit limit.","format":"float","type":"number"},"creditLimitPercentage":{"$ref":"#/components/schemas/CreditLimitPercentage"},"fees":{"description":"The loan fees.","properties":{"drawFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the draw fee. The draw fee will be due on a due date of the period the draw was activated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only one of the following values, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFeeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFeePercentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"drawFeePercentageOfPrincipal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the purchases total amount. The system will calculate the draw fee amount based on the total"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of purchases in the period the draw was activated. The draw fee will be due on a due date of the period the draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was activated.  Pass only one of the following values, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFeeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFeePercentageOfPrincipal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"dynamicFees":{"$ref":"#/components/schemas/AtOriginationDynamicFees"},"serviceFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service fee amount that will be charged recurrently. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFees.feeCapAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"gracePeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logic to handle grace period benefit. The draw level grace period functionality depends on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"line/loan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute value that was passed in the Create loan endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The loan/line and all draws must meet the grace period repayment requirement. If one of the draws"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"didn't meet the repayment requirement (in other words the entire line didn't meet the repayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requirement), all draws eligible for the grace period benefit would lose the grace period benefit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and accrue interest."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To configure the grace period benefit on a draw:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assuming you enrolled the line/loan in the grace period benefit when you created the loan/line via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create loan endpoint, you can set the following draw-level attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.isGracePeriodApplicable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the draw participates in the eligibility evaluation for the entire line/loan. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draw will accrue interest based on the draw interest rate even when the line is eligible for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the draw participates in the eligibility evaluation for the entire line/loan. The draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will NOT accrue interest in periods when the loan/line is eligible for the grace period benefit."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.paymentRequirementForGrace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - defines what portion of the draw needs to be repaid every"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period to keep the line eligible for the benefit."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep in mind that you can set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.isGracePeriodApplicable=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" AND"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.paymentRequirementForGrace = [minAmount, fullBalance]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It means that the draw will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accrue interest (aka not subject to the grace period benefit). But, the line eligibility"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depends on repayment of a portion of the draw. This configuration can be used for amortized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draws when the borrower is expected to accrue interest but has to pay the amortized recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount every period to keep the line eligible for the grace period."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.numPeriodsToRestoreGrace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - is superseded by the line/loan level's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numPeriodsToRestoreGrace"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following configurations are not allowed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" AND "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.paymentRequirementForGrace=none"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draw.isGracePeriodApplicable=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for amortized draws. Amortized draws can participate in grace"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligibility evaluation for a line/loan, but are not designed to be subject to the grace period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"benefit (in other words, amortized draws are expected to accrue interest if an interest rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than zero was set on the draw)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is not passed, the system will assume that grace period benefit is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable to the draw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important: the grace period attributes cannot be changed after the draw is activated."},"children":[]}]}]}],"properties":{"isGracePeriodApplicable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how the interest on draw should accrue when the draw is eligible for the grace period benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the draw will accrue interest regardless of the grace period benefit eligibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the draw will NOT accrue interest in periods when the loan/line and/or draw is eligible for the grace period benefit."},"children":[]}]}]}],"type":"boolean"},"numPeriodsToRestoreGrace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you enrolled the loan/line in the grace period benefit when you created the loan via the Create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan endpoint, don't pass this attribute. The system will set the draw-level value equal to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loan/line-level value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numPeriodsToRestoreGrace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"paymentRequirementForGrace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute determines the portion of a draw that needs to be repaid every period in order for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the line/loan and/or draw to be eligible for the grace period benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that ALL draws participate in the eligibility evaluation regardless of the draw-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodApplicable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - requires the minimum amount of the draw to be paid every period."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an amortized draw, the minimum amount is the amortized periodic/recurring amount and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a non-amortized draw, the minimum amount is what statement logic calculates."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - requires the full balance of the draw to be paid every period. Don't set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for amortized draws."},"children":[]}]}]}]}],"enum":["minAmount","fullBalance"],"type":"string"}},"type":"object"},"interestRates":{"$ref":"#/components/schemas/LoanInterestRatesAtOrigination"},"mdr":{"$ref":"#/components/schemas/MerchantDiscountRateObj"},"minPaymentCalculation":{"$ref":"#/components/schemas/MinPaymentCalculation"},"promoRates":{"$ref":"#/components/schemas/LoanPromoRatesAtOrigination","nullable":true},"rateCaps":{"$ref":"#/components/schemas/RateCapsAtOriginationDraw"}},"type":"object"}},"components/schemas/DrawAtOriginationCreate":{"id":"components/schemas/DrawAtOriginationCreate","kind":"json-schema","title":"DrawAtOriginationCreate","data":{"allOf":[{"$ref":"#/components/schemas/DrawAtOrigination"},{"properties":{"minPaymentCalculation":{"allOf":[{"$ref":"#/components/schemas/MinPaymentCalculation"},{"required":["percentageOfPrincipal"],"type":"object"}]}},"type":"object"}]}},"components/schemas/BaseDraw":{"id":"components/schemas/BaseDraw","kind":"json-schema","title":"BaseDraw","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixinWithoutTimestamps"},{"$ref":"#/components/schemas/BaseLoanMixin"},{"properties":{"atOrigination":{"$ref":"#/components/schemas/DrawAtOriginationCreate","required":["minPaymentCalculation"]},"current":{"allOf":[{"properties":{"creditLimitAmount":{"description":"The credit limit amount.","format":"float","type":"number"},"duration":{"$ref":"#/components/schemas/LoanDuration"},"minPaymentCalculation":{"$ref":"#/components/schemas/MinPaymentCalculation"},"paymentFrequency":{"$ref":"#/components/schemas/InstallmentPaymentFrequency"},"periodicPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most recent amortized periodic payment that was calculated on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastAmortizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"type":"object"}],"description":"This object contains some draw details that were modified after origination.","readOnly":true},"isClosed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the Draw is closed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", new Purchases cannot be created."},"children":[]}]}]}],"type":"boolean"},"nickname":{"default":"Draw","description":"The draw's nickname as displayed in the UI.","type":"string"},"object":{"enum":["draw"],"readOnly":true,"type":"string"},"ratesValidation":{"allOf":[{"$ref":"#/components/schemas/InterestRateValidation"}],"description":"This object contains information on whether actual rates exceed the rate ranges defined on the loan type.","readOnly":true},"status":{"$ref":"#/components/schemas/LoanStatus"}},"required":["status"],"type":"object"}],"title":"BaseDraw"}},"components/schemas/DrawResponse":{"id":"components/schemas/DrawResponse","kind":"json-schema","title":"Draw Response","data":{"allOf":[{"$ref":"#/components/schemas/BaseDraw"},{"properties":{"drawType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in which lenders set up draws specifically to be used for cash advances, balance transfers, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashAdvance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - must be set in order for Peach's system to automatically associate ATM withdrawal and other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cash-specific transactions with a specific draw. See Create card issuer endpoint and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute for additional configuration details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw that will house balance transfer transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regularPurchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's system will automatically associate purchases with this draw based on the card issuer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a special draw capturing all past data prior to the \"migration cutoff date\" for a migrated Line of Credit. Automatically created by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system when a Line of Credit is created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationStatus=prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["balanceTransfer","cashAdvance","regularPurchase","static"],"nullable":true,"type":"string"}},"type":"object"}],"title":"Draw Response"}},"components/schemas/DrawsPaging":{"id":"components/schemas/DrawsPaging","kind":"json-schema","title":"DrawsPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DrawResponse"},"type":"array"}},"type":"object"}]}},"components/schemas/Draw":{"id":"components/schemas/Draw","kind":"json-schema","title":"Draw","data":{"allOf":[{"$ref":"#/components/schemas/BaseDraw"},{"properties":{"drawType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in which lenders set up draws specifically to be used for cash advances, balance transfers, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashAdvance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - must be set in order for Peach's system to automatically associate ATM withdrawal and other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cash-specific transactions with a specific draw. See Create card issuer endpoint and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute for additional configuration details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw that will house balance transfer transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regularPurchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's system will automatically associate purchases with this draw based on the card issuer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logic."},"children":[]}]}]}],"enum":["balanceTransfer","cashAdvance","regularPurchase"],"nullable":true,"type":"string"}},"type":"object"}],"title":"Draw"}},"components/schemas/DrawAtOriginationUpdate":{"id":"components/schemas/DrawAtOriginationUpdate","kind":"json-schema","title":"DrawAtOriginationUpdate","data":{"allOf":[{"$ref":"#/components/schemas/DrawAtOrigination"},{"properties":{"minPaymentCalculation":{"$ref":"#/components/schemas/MinPaymentCalculation"}},"type":"object"}]}},"components/schemas/DrawActivationResponse":{"id":"components/schemas/DrawActivationResponse","kind":"json-schema","title":"DrawActivationResponse","data":{"properties":{"amountsValidation":{"$ref":"#/components/schemas/AmountsValidation"},"schedule":{"$ref":"#/components/schemas/LoanSchedule"}},"type":"object"}},"components/schemas/ExpectedPaymentsResult":{"id":"components/schemas/ExpectedPaymentsResult","kind":"json-schema","title":"ExpectedPaymentsResult","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"properties":{"paymentFrequency":{"description":"The expected payments' frequency.","enum":["weekly","everyTwoWeeks","twiceMonthly","monthly","singleTerm"],"type":"string"},"schedule":{"items":{"$ref":"#/components/schemas/ExpectedPayment"},"type":"array"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"type":"object"}]}},"components/schemas/DeferRemainingBalancesRequest":{"id":"components/schemas/DeferRemainingBalancesRequest","kind":"json-schema","title":"DeferRemainingBalancesRequest","data":{"properties":{"caseId":{"description":"An identifier of an existing case.\n","nullable":true,"type":"string"},"deferralType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of deferral."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizeRemainingBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will capitalize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the remaining balance, overdue or due, of each obligation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponding to the selected due dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capitalization means the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdue/due principal will become non-due principal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdue/due interest will become non-due principal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdue/due fees will become non-due principal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The net effect on the loan balance right after the deferral"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep in mind that because interest and fees are capitalized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(aka principal increased), the borrower may accrue more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will not check the line of credit and/or draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level credit limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, If the line or draw balance before the deferral"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was above the credit limit, the system will still complete"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the deferral process."},"children":[]}]}]}],"enum":["capitalizeRemainingBalance"],"nullable":false,"type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change and no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changes are saved to the database. The preview mode allows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you to see the total and breakdown of the deferred amounts."},"children":[]}]}]}],"nullable":false,"type":"boolean"},"selectedDueDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected due dates to defer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can only be due dates for which the statement was already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Past due dates should always have statements. Upcoming due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date can only be selected if the statement was already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't pass a value, the system will find all due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dates / obligations with remaining balance and defer them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass a value, make sure you don't create \"holes\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hole is defined as leaving one or more due dates with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remaining balance while trying to defer more recent due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dates. The exception is we allow deferring only the most"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recent due obligation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line has three due dates / obligations with remaining"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jul 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aug 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot pass the following due dates combinations:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jul 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - because it makes Jun 5 a \"hole\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jul 5, Aug 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - because it makes Jun 5 a \"hole\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aug 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - because it makes Jun 5 and Jul 5 \"holes\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 5, Aug 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - because it makes Jul 5 \"holes\"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can pass the following due dates combinations:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 5, Jul 5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 5, Jul 5, Aug 5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aug 5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the most recent due obligation"},"children":[]}]}]}]}]}]}],"items":{"format":"date","nullable":false,"type":"string"},"nullable":false,"type":"array"}},"required":["deferralType"],"type":"object"}},"components/schemas/DeferRemainingBalancesResponse":{"id":"components/schemas/DeferRemainingBalancesResponse","kind":"json-schema","title":"DeferRemainingBalancesResponse","data":{"properties":{"deferredDrawIds":{"description":"The list of draws that participated in the deferral process.\n","items":{"nullable":false,"type":"string"},"type":"array"},"deferredDueDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of due dates that were deferred."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep in mind that this list can be different from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list that was provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included a due date that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"didn't have corresponding obligation's remaining balance >"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0, the system will skip the due date and will not include it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedDueDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return all due dates with corresponding obligation's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remaining balance > 0 that were deferred."},"children":[]}]}]}],"items":{"format":"date","nullable":false,"type":"string"},"nullable":false,"type":"array"},"totalDeferredAmounts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amount that was deferred."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clarify, this is the sum of all amounts that were"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deferred across all due dates with corresponding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"obligation's remaining amount > 0."},"children":[]}]}]}],"properties":{"allFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total of all fees portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deferred."},"children":[]}]}]}],"format":"float","nullable":false,"type":"number"},"interestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deferred."},"children":[]}]}]}],"format":"float","nullable":false,"type":"number"},"principalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deferred."},"children":[]}]}]}],"format":"float","nullable":false,"type":"number"},"totalAmount":{"description":"The total deferred amount that was previously overdue or\ndue.\n","format":"float","nullable":false,"type":"number"}},"required":["totalAmount","interestAmount","principalAmount","allFeesAmount"],"type":"object"}},"type":"object"}},"components/schemas/DrawMigrationBalances":{"id":"components/schemas/DrawMigrationBalances","kind":"json-schema","title":"DrawMigrationBalances","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw level balances passed here should be as of the \"migration cutoff date\" after the most recent statement was generated in your legal system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We expect "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include interest FOR the last date of the previous period (aka endDate) but not for the most recent statement date (which is also the first day of the migration period)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balances should be as of Aug 1, 2024 after the statement was generated on Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of day principal balance on Jul 31, 2024: $100.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The line/draw accrues daily simple interest of 18% annually (with 360 method)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balances passed to Peach should include the daily interest that was accrued at the end of the day Jul 31, 2024:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$100.00 * (0.18 / 360) = $0.05"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach system will accrue daily interest for the end of the day Aug 1, 2024 day balance and onward."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not double-count fees: a fee you charge on the regular (non-static) draw that it belongs to with a charge date on or after the \"migration cutoff date\" writes itself to the ledger. For any such fee, either include its amount in these balances OR charge it through the fees endpoint; never both, or the borrower will be billed twice."},"children":[]}]}]}],"properties":{"creditLimitAmount":{"description":"The draw credit limit amount as of the \"migration cutoff date\".\n","format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueBalances":{"description":"Due balances represent balances that are currently due.","properties":{"dueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"duePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["duePrincipalAmount","dueInterestAmount","dueDrawFeesAmount","dueLateFeesAmount","dueModificationFeesAmount"],"type":"object"},"nonDueBalances":{"description":"Non-due balances represent balances that are not yet due.","properties":{"nonDueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"nonDueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"nonDueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"nonDueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"nonDuePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["nonDuePrincipalAmount","nonDueInterestAmount","nonDueDrawFeesAmount","nonDueLateFeesAmount","nonDueModificationFeesAmount"],"type":"object"},"overdueBalances":{"description":"Overdue balances represent balances that are overdue.","properties":{"overdueDrawFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"overdueInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue interest portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"overdueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"overdueModificationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modification fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"overduePrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue principal portion of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["overduePrincipalAmount","overdueInterestAmount","overdueDrawFeesAmount","overdueLateFeesAmount","overdueModificationFeesAmount"],"type":"object"}},"required":["nonDueBalances","dueBalances","overdueBalances"],"type":"object"}},"components/schemas/BaseMigrationGracePeriod":{"id":"components/schemas/BaseMigrationGracePeriod","kind":"json-schema","title":"BaseMigrationGracePeriod","data":{"properties":{"fullBalanceAmount":{"description":"The full balance amount of the line that is eligible for grace period.","format":"float","minimum":0,"multipleOf":0.01,"nullable":true,"type":"number"},"fullBalanceMinusOverdueAmount":{"description":"The full balance amount minus the overdue amount.","format":"float","minimum":0,"multipleOf":0.01,"nullable":true,"type":"number"},"isGracePeriodEligible":{"default":true,"description":"Was the loan eligible for grace in this period?","nullable":false,"type":"boolean"}},"required":["fullBalanceAmount","fullBalanceMinusOverdueAmount"],"type":"object"}},"components/schemas/DrawMigrationGracePeriod":{"id":"components/schemas/DrawMigrationGracePeriod","kind":"json-schema","title":"DrawMigrationGracePeriod","data":{"allOf":[{"$ref":"#/components/schemas/BaseMigrationGracePeriod"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not migrating past periods and the migration period is the first period of the LOC:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are migrating past periods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the draw level grace period details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw level grace period data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the draw level grace period data is part of the \"Create migration period draw data\" vs \"Create past periods data\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The migration period is a \"live\" period in which you execute migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the Peach system needs to know if the LOC is eligible for the grace period benefit when the migration period starts, the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed here. If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will start migration without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accruing interest in the \"migration period\". If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will start migration with accruing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest in the \"migration period\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the \"due date + 1\" within the \"migration period\", the system evaluates the grace eligibility based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalanceMinusOverdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and payments made."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you migrate the LOC/draw before the upcoming \"due date\", the system will evaluate the grace period eligibility in \"live\" and might revoke the benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you migrate the LOC/draw after the \"due date\", the system will evaluate the grace period eligibility as part of the \"replay/migration\" process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because of existing limitations with \"replay\", grace period eligibility cannot be revoked as part of the replay process. However, the replay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process can reinstate the grace period benefit (in other words, waive accrued interest from the start of the \"migration period\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach is responsible for generating the statement corresponding to the migration period on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period details of the migration period will be calculated by the Peach system on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw level grace period details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts and values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system."},"children":[]}]}]}]}]}]}],"type":"object"}]}},"components/schemas/MigratedDaysOverdue":{"id":"components/schemas/MigratedDaysOverdue","kind":"json-schema","title":"MigratedDaysOverdue","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This represents the number of days overdue prior to the \"migration cutoff\" date as it appears in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the other system (not Peach). This value is normally calculated as the number of calendar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days overdue starting from the earliest overdue obligation's due date to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"migration cutoff date\". This value, once set, won't change after the migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value will be prorated and added to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daysOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of future obligations"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(if any become overdue). The system will prorate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedDaysOverdue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dynamically as the borrower makes payments and add it to the days overdue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"post \"migration cutoff date\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation details:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedDaysOverdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will be used to prorate days overdue prior to the \"migration cutoff date\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on the paid balance of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedOverdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (which is set based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances.overdueBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"round_down [migratedDaysOverdue x (1 - min(fulfilledAmount / migratedOverdueAmount, 1))]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"migratedDaysOverdue = 60"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"migratedOverdueAmount = $1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 1:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower didn't make any payment within the first 30 days after the \"migration cutoff date\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total days overdue:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60 x (1 - min(0 / 1000, 1)) + 30 = 90"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 2:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Borrower made payments in a total amount of $700 within the first 30 days after the \"migration cutoff date\". The line is still overdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total days overdue:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60 x (1 - min(700 / 1000, 1)) + 30 = 48"},"children":[]}]}]}]}]}]}]}]}]}]}],"minimum":0,"nullable":false,"type":"integer"}},"components/schemas/DrawMigrationObligation":{"id":"components/schemas/DrawMigrationObligation","kind":"json-schema","title":"DrawMigrationObligation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not migrating past periods and the migration period is the first period of the LOC:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are migrating past periods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the draw level obligation details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw level data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the draw level obligation data is part of the \"Create migration period draw data\" vs \"Create past periods\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remind, the migration period is a \"live\" period in which you execute migration. The draw level obligation details of the migration period will be calculated by the Peach system. Peach is also responsible for generating the statement corresponding to the migration period on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw level obligation details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts and other values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system."},"children":[]}]}]}]}]}]}],"properties":{"migratedDaysOverdue":{"$ref":"#/components/schemas/MigratedDaysOverdue"},"obligationAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining amount of the previous period's obligation that a borrower needs to pay on the due date that comes after \"migration cutoff date\". The remaining amount should be as of \"migration cutoff date\" vs. \"migration at date\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the draw level remaining obligation amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your LOC (or credit card) product doesn't count payments that were made before the statement date towards the statement minimum amount, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be always equal to the draw portion of the whole statement minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 1:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, $30 was counted towards the $100 minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining minimum amount of $70 is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=70"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 2:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, none of the payments were counted toward the $100 minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum amount of $100 is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 3:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made early payments in the previous period, and based on your waterfall configuration in the legacy system, the payments were counted toward the $100 minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining minimum amount of $0 is due on Aug 22, 2024 (in other words, the borrower doesn't need to pay anything on Aug 22, 2024.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"nullable":false,"type":"number"}},"required":["obligationAmount","migratedDaysOverdue"],"type":"object"}},"components/schemas/MigrationPeriodDrawData":{"id":"components/schemas/MigrationPeriodDrawData","kind":"json-schema","title":"MigrationPeriodDrawData","data":{"properties":{"balances":{"$ref":"#/components/schemas/DrawMigrationBalances"},"gracePeriod":{"$ref":"#/components/schemas/DrawMigrationGracePeriod"},"obligation":{"$ref":"#/components/schemas/DrawMigrationObligation"}},"type":"object"}},"components/schemas/MigrationPeriodDrawDataResponse":{"id":"components/schemas/MigrationPeriodDrawDataResponse","kind":"json-schema","title":"MigrationPeriodDrawDataResponse","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/MigrationPeriodDrawData"},{"properties":{"migratedOverdueAmount":{"format":"float","nullable":true,"type":"number"}},"type":"object"}]}},"type":"object"}]}},"components/schemas/MigrationPeriodDrawDataWithRequired":{"id":"components/schemas/MigrationPeriodDrawDataWithRequired","kind":"json-schema","title":"MigrationPeriodDrawDataWithRequired","data":{"allOf":[{"$ref":"#/components/schemas/MigrationPeriodDrawData"},{"required":["obligation","gracePeriod","balances"],"type":"object"}]}},"components/schemas/ObligationAmountFields":{"id":"components/schemas/ObligationAmountFields","kind":"json-schema","title":"ObligationAmountFields","data":{"properties":{"capitalizedAmount":{"description":"The total amount capitalized at the end of the period.\n","format":"float","nullable":true,"type":"number"},"fulfilledAmount":{"description":"The total amount of payments and service credits applied to the period.\n","format":"float","nullable":true,"type":"number"},"obligationAmount":{"description":"The amount obligated to be paid by the borrower for the period.\n","format":"float","type":"number"},"overLimitAmount":{"format":"float","nullable":true,"type":"number"},"overpaymentsAmount":{"description":"In the case that loan policy allows, this represents the amount of overpayments applied to the period.\nOverpayments will only arise when an obligation is completely fulfilled.\n","format":"float","nullable":true,"type":"number"},"paymentsAmount":{"description":"The total amount of payments applied to the period.\n","format":"float","nullable":true,"type":"number"},"remainingAmount":{"description":"The total amount remaining to be paid by the borrower after accounting for payments\nand service credits applied in the period.\n","format":"float","nullable":true,"type":"number"},"serviceCreditsAmount":{"description":"The total amount of service credits applied to the period.\n","format":"float","nullable":true,"type":"number"},"unassignedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a special amount that only applies to loan types with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationFulfilledCalculation=postStatement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationFulfilledCalculation=postDueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not counted towards an obligation's fulfilled amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the first obligation, it stores any payment amount that was made before the first statement date (postStatement) or due date (postDueDate) and is not allocated to any obligation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For subsequent obligations, it stores any payment amount that was made between the previous period's due date +1 (inclusive) and current period's end date (inclusive)."},"children":[]}]}]}]}],"format":"float","nullable":true,"type":"number"}},"type":"object"}},"components/schemas/ObligationOtherFields":{"id":"components/schemas/ObligationOtherFields","kind":"json-schema","title":"ObligationOtherFields","data":{"properties":{"dueDate":{"description":"The due date of the obligation/period in the product timezone.","format":"date","type":"string"},"isFulfilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower has completely fulfilled the obligation amount for the period."},"children":[]}]}]}],"type":"boolean"},"isLateFeeBlockedByPyramidingConfig":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pyramiding of late fees is a situation where a borrower (who has been previously charged a late fee) pays the current amount due"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a loan without the prior month's late fee included, and the payment is applied to the late fee first, leaving an overdue balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the current month's payment, resulting in another late fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the late fee was configured to allow pyramiding effect, this attribute is not used and will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the late fee was configured to prevent pyramiding effect ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pyramidingLateFeesAllowed=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), this attribute:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means a late fee was blocked (aka not charged in the period) because of the late fee pyramiding configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"But otherwise would have been charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means a late fee was charged because the loan was overdue, or a late fee was not supposed to be charged because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the loan was current. To clarify, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't necessarily mean that a late fee was charged in the period. To understand"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether a late fee was charged in the period, you should check the dynamic fees endpoint or applicable database table(s)."},"children":[]}]}]}]}]}]}],"type":"boolean"},"isOpen":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is still \"open\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not final. The obligation amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can potentially change until the period ends. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means that the obligation is \"sealed\" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is final."},"children":[]}]}]}],"type":"boolean"},"isOverdue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower is currently overdue on the obligation amount for the period."},"children":[]}]}]}],"type":"boolean"},"migration":{"description":"Used in Line of Credit migration.\n","properties":{"migratedDaysOverdue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of calendar days overdue as of the \"migration cutoff date\". This value is pro-rated based on the percentage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedOverdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paid by the borrower."},"children":[]}]}]}],"nullable":true,"type":"integer"},"migratedOverdueAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue balance as of the \"migration cutoff date\". This value is equal to the total of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances.overdueBalances"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is used to initiate the ledger as of the \"migration cutoff date\". This value won't change after the migration."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"migratedOverdueRemainingAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overdue balance remaining to be paid as of the \"migration cutoff date\". This value starts out equal to the total of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances.overdueBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and decreases as subsequent payments are made by the borrower."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"readOnly":true,"type":"object"},"periodId":{"description":"The period identifier.","type":"string"}},"type":"object"}},"components/schemas/ObligationGracePeriod":{"id":"components/schemas/ObligationGracePeriod","kind":"json-schema","title":"ObligationGracePeriod","data":{"description":"Data used for grace period logic.","properties":{"fullBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic. The fullBalanceAmount is dependent on the repaymentCriteriaForGrace attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = none, this value is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = minAmount, this amount is the obligation for this period and the unpaid portion of past obligations as of the date when the obligation is \"sealed\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit (and Draw) obligations are \"sealed\" on the statement date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = fullBalance, this amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is \"sealed\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit (and Draw) obligations are \"sealed\" on the statement date."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"fullBalanceMinusOverdueAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic. The fullBalanceMinusOverdueAmount is dependent on the repaymentCriteriaForGrace attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = none, this value is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = minAmount, this amount is the obligation for this period as of the date when the obligation is \"sealed\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit (and Draw) obligations are \"sealed\" on the statement date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For repaymentCriteriaForGrace = fullBalance, this amount is the full statement balance amount (also called \"new balance\")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minus any overdue amount as of the date when the obligation is \"sealed\" (aka when isOpen is set to false)."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"isGracePeriodEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period status of the obligation period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period was not eligible for the grace period benefit and interest accrued in the period."},"children":[]}]}]}],"type":"boolean"},"totalFulfilledOnDueDateAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is only used for grace period benefit logic. The value will be set one calendar day after the due date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due date. This is a sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilledAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overpaymentsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"type":"object"}},"components/schemas/ObligationResult":{"id":"components/schemas/ObligationResult","kind":"json-schema","title":"ObligationResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/ObligationAmountFields"},{"$ref":"#/components/schemas/ObligationOtherFields"},{"properties":{"gracePeriod":{"$ref":"#/components/schemas/ObligationGracePeriod"}},"type":"object"}]}},"components/schemas/ObligationsResult":{"id":"components/schemas/ObligationsResult","kind":"json-schema","title":"ObligationsResult","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"properties":{"daysOverdue":{"description":"Number of calendar days overdue starting from the due date of the earliest overdue obligation to\nthe current date.\n","type":"integer"},"isOverdue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower has any obligation overdue on the loan."},"children":[]}]}]}],"type":"boolean"},"obligations":{"items":{"$ref":"#/components/schemas/ObligationResult"},"type":"array"},"overdueAmount":{"description":"The total overdue amount across all obligations on the loan.\n","format":"float","type":"number"}},"type":"object"}]}},"components/schemas/PromoProgramPost":{"id":"components/schemas/PromoProgramPost","kind":"json-schema","title":"PromoProgramPost","data":{"allOf":[{"$ref":"#/components/schemas/PromoProgramCreate"},{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"}},"type":"object"}],"description":"Create a promo program"}},"components/schemas/PromoCancelReason":{"id":"components/schemas/PromoCancelReason","kind":"json-schema","title":"PromoCancelReason","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adminError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo program was added by mistake."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promo was disqualified for various"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerOptedOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the borrower decided to opt out from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]}]}]}],"enum":["adminError","expired","disqualified","borrowerOptedOut"],"type":"string"}},"components/schemas/PromoProgramResult":{"id":"components/schemas/PromoProgramResult","kind":"json-schema","title":"PromoProgramResult","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"description":{"description":"A legal description of the promotional program as it should\nbe communicated and shown to borrowers.\nIf the description is provided, borrowers will see the\ndescription in the Borrower Portal.\n","nullable":true,"readOnly":true,"type":"string"},"displayName":{"description":"The promotional program name as it is shown to borrowers.","readOnly":true,"type":"string"},"disqualifyOverdueDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of loan overdue days that would disqualify the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any occurrence of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualifyOverdueDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or more of number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days overdue during the promotional period would disqualify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(aka cancel) the promotional program."},"children":[]}]}]}],"type":"integer"},"externalId":{"description":"A lender's unique identifier for a specific promotional\nprogram.\n","type":"string"},"id":{"description":"The promotional program's unique identifier.","readOnly":true,"type":"string"},"loanId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"description":"The ID of the loan the promo program applies to."}]},"metaData":{"description":"Store any type of key/value pairs in the form of a JSON\ndictionary.\n","nullable":true,"type":"object"},"promoCancelReason":{"$ref":"#/components/schemas/PromoCancelReason"},"promoCanceledBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for canceling the promotion\nprogram.\nCan be an borrower, agent, or automated system process.\n"},"promoDurationDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program duration as a number of calendar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will calculate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"promoEffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program effective end-date inclusive of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoGracePeriodDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoGracePeriodDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEffectiveEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","readOnly":true,"type":"string"},"promoEndDate":{"$ref":"#/components/schemas/PromoEndDate"},"promoGracePeriodDays":{"$ref":"#/components/schemas/PromoGracePeriodDays"},"promoStartDate":{"$ref":"#/components/schemas/PromoStartDate"},"promoType":{"$ref":"#/components/schemas/PromoType"},"promoTypeId":{"description":"The promotional program type's unique identifier.","type":"string"},"remainingAmountToExercise":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining amount needed to satisfy the Same-As-Cash"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotion."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoStatus=active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"sacExcercisedRateId":{"description":"The unique rate ID that was created to set on the loan in\norder to exercise the promotion rate.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program status on a specific loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was created but was not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activated yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion has been canceled for a reason."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoCancelReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was successfully exercised."},"children":[]}]}]}],"enum":["pending","active","canceled","exercised"],"readOnly":true,"type":"string"},"timestamps":{"description":"Timestamps of the transaction statuses.","properties":{"activatedAt":{"format":"date-time","type":"string"},"canceledAt":{"format":"date-time","type":"string"},"createdAt":{"format":"date-time","type":"string"},"exercisedAt":{"format":"date-time","type":"string"},"reactivatedAt":{"format":"date-time","type":"string"}},"type":"object"},"totalDeferredInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total deferred interest amount at the time when promo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the promotion is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the total deferred interest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is added to the loan interest and the borrower is expected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pay it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the promotion is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the total deferred"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest is foregone and the borrower is not expected to pay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the promo status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the value will be empty."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to know how much deferred interest was accrued"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" promotion, please use \"Get loan balances\" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Get draw balances\" endpoints."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/PromoProgramPutCommon":{"id":"components/schemas/PromoProgramPutCommon","kind":"json-schema","title":"PromoProgramPutCommon","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"disqualifyOverdueDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of loan overdue days that would disqualify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the promotional program."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any occurrence of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disqualifyOverdueDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or more during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the promotional period would disqualify (aka cancel) the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"promotional program."},"children":[]}]}]}],"type":"integer"},"externalId":{"description":"A lender's unique identifier for a specific promotional\nprogram.\n","type":"string"},"metaData":{"description":"Store any type of key/value pairs in the form of a JSON\ndictionary.\n","nullable":true,"type":"object"},"promoDurationDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program duration as a number of calendar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass only one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoDurationDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"promoEndDate":{"$ref":"#/components/schemas/PromoEndDate"},"promoGracePeriodDays":{"$ref":"#/components/schemas/PromoGracePeriodDays"},"promoStartDate":{"$ref":"#/components/schemas/PromoStartDate"}},"type":"object"}},"components/schemas/PromoProgramDeleteResult":{"id":"components/schemas/PromoProgramDeleteResult","kind":"json-schema","title":"PromoProgramDeleteResult","data":{"allOf":[{"$ref":"#/components/schemas/PromoProgramResult"},{"properties":{"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the system will send a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoProgramCanceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/PurchaseExtraInput":{"id":"components/schemas/PurchaseExtraInput","kind":"json-schema","title":"PurchaseExtraInput","data":{"properties":{"authorizedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the purchase was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This value can be set by lenders at the time of purchase creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not set by the lender, it will be populated based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if it is non-null) otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not set by the lender and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, this value corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase.authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the purchase was never in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and none of the prior conditions are met, this value will be null."},"children":[]}]}]}],"format":"date-time","type":"string"},"effectiveAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective timestamp when the purchase was applied in the ledger. This attribute can be passed only during the line of credit migration process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't use this attribute after the migration process was successfully completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to the timestamp when the purchase is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, whichever comes first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timezone is UTC for this timestamp and the format is ISO. For example, in order to set a purchase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to July 28th 2022,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10:44 am PDT, send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-07-28T17:44:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"}},"components/schemas/PurchaseValidationWarnings":{"id":"components/schemas/PurchaseValidationWarnings","kind":"json-schema","title":"PurchaseValidationWarnings","data":{"description":"Soft validation warnings for fields the system accepted without enforcing.","properties":{"cardIdMissing":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided but could not be resolved to a card on this loan."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PurchaseCreateOrUpdateResponse":{"id":"components/schemas/PurchaseCreateOrUpdateResponse","kind":"json-schema","title":"PurchaseCreateOrUpdateResponse","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Purchase"},"validation":{"$ref":"#/components/schemas/PurchaseValidationWarnings"}},"type":"object"}]}},"components/schemas/PurchaseUpdate":{"id":"components/schemas/PurchaseUpdate","kind":"json-schema","title":"PurchaseUpdate","data":{"properties":{"amount":{"description":"The amount of the purchase.","minimum":0,"type":"number"},"authorizationPurchaseId":{"description":"Peach's unique or lender's external identifier for the authorization purchase. This attribute is used to reference an initial authorization, so\nlenders know which captures (purchase object(s) in Peach) are related to the original authorization.\n","type":"string"},"authorizedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the purchase was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","type":"string"},"cardId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach id, Peach public id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CD-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or lender external id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the card used for this purchase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolved against cards belonging to this line of credit. If the card cannot be resolved (unknown id or wrong loan),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the purchase is still updated and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation.cardIdMissing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]}]}]}],"maxLength":200,"nullable":true,"type":"string"},"declineReason":{"$ref":"#/components/schemas/PurchaseDeclineReason","description":"The reason the purchase was declined"},"effectiveAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective timestamp when the purchase was applied in the ledger. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to the timestamp when the purchase is set to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, whichever comes first. Changing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Update purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint will trigger a replay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the line of credit. Keep in mind that an existing statement might've included the purchase based on the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the interest was accrued based on the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated only if the purchase is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timezone is UTC for this timestamp and the format is ISO."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, in order to set a purchase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to July 28th 2022, 10:44 am PDT, send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-07-28T17:44:00Z"},"children":[]}]}]}],"example":"2022-06-10T11:45Z","format":"date-time","type":"string"},"externalId":{"description":"The lender's identifier for the purchase.","nullable":true,"type":"string"},"metadata":{"type":"object"},"originalPurchaseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's unique or lender's external identifier. Typically used for purchases of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which allows the lender to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the original purchase being refunded. For authorizations, please see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}],"type":"string"},"purchaseDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of a purchase. This attribute can be passed only during the line of credit migration process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't use this attribute after the migration process was successfully completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be before or equal to today, and cannot be greater than the \"migration at date\" (aka the actual date on which you run the migration.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you cannot pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at 6:00 AM in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, you must pass both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-migrated purchases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is equal to the date part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" converted to the product timezone (e.g. Eastern or Pacific)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null, this value is equal to the date part of the purchase's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" converted to the product timezone."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in Get endpoints for both migrated and non-migrated purchases."},"children":[]}]}]}],"format":"date","type":"string"},"purchaseDetails":{"$ref":"#/components/schemas/PurchaseDetails"},"status":{"$ref":"#/components/schemas/PurchaseStatus"}},"type":"object"}},"components/schemas/PurchaseUpdateInternal":{"id":"components/schemas/PurchaseUpdateInternal","kind":"json-schema","title":"PurchaseUpdateInternal","data":{"allOf":[{"$ref":"#/components/schemas/PurchaseUpdate"},{"properties":{"refundDetails":{"$ref":"#/components/schemas/InternalRefundDetails"}},"type":"object"}]}},"components/schemas/RateCapEndDate":{"id":"components/schemas/RateCapEndDate","kind":"json-schema","title":"RateCapEndDate","data":{"description":"Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.\n","format":"date","nullable":true,"type":"string"}},"components/schemas/RateCapStartDate":{"id":"components/schemas/RateCapStartDate","kind":"json-schema","title":"RateCapStartDate","data":{"description":"Rate cap start date in product timezone, inclusive.","format":"date","type":"string"}},"components/schemas/RateCap":{"id":"components/schemas/RateCap","kind":"json-schema","title":"Rate Cap","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Rate Cap object represents the rate caps associated with each loan or draw."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate caps apply to both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate types. If two or more rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"caps overlap on the same dates, we will use the lowest value."},"children":[]}]}]}],"properties":{"createdAt":{"description":"When the rate cap was created.","format":"date-time","type":"string"},"endDate":{"$ref":"#/components/schemas/RateCapEndDate"},"id":{"description":"The rate cap identifier.","type":"string"},"maxRate":{"$ref":"#/components/schemas/RateCapMaxRate"},"rateCapReason":{"$ref":"#/components/schemas/RateCapReason"},"startDate":{"$ref":"#/components/schemas/RateCapStartDate"},"updatedAt":{"description":"When the rate cap was last updated.","format":"date-time","type":"string"}},"title":"Rate Cap","type":"object"}},"components/schemas/RateCapAdd":{"id":"components/schemas/RateCapAdd","kind":"json-schema","title":"Rate Cap Add","data":{"description":"Request body for adding a new rate cap.","properties":{"endDate":{"$ref":"#/components/schemas/RateCapEndDate"},"maxRate":{"$ref":"#/components/schemas/RateCapMaxRate"},"rateCapReason":{"$ref":"#/components/schemas/RateCapReason"},"startDate":{"$ref":"#/components/schemas/RateCapStartDate"}},"required":["maxRate","startDate","rateCapReason"],"title":"Rate Cap Add","type":"object"}},"components/schemas/RateCapId":{"id":"components/schemas/RateCapId","kind":"json-schema","title":"RateCapId","data":{"description":"The rate cap identifier.","example":"RC-ABCD-1234","pattern":"^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$","type":"string"}},"components/schemas/RateCapUpdate":{"id":"components/schemas/RateCapUpdate","kind":"json-schema","title":"Rate Cap Update","data":{"description":"Request body for updating an existing rate cap.","properties":{"endDate":{"$ref":"#/components/schemas/RateCapEndDate"},"maxRate":{"$ref":"#/components/schemas/RateCapMaxRate"},"rateCapReason":{"$ref":"#/components/schemas/RateCapReason"},"startDate":{"$ref":"#/components/schemas/RateCapStartDate"}},"title":"Rate Cap Update","type":"object"}},"components/schemas/LoanRate":{"id":"components/schemas/LoanRate","kind":"json-schema","title":"LoanRate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan can have multiple rates. If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overlap on the same date we use the lowest value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overlap on the same date, we take the sum of the promo rates for the given day, and cap this rate at the maximum interest rate for the given day (to avoid accruing negative interest)."},"children":[]}]}]}],"properties":{"annualRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest or promo rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate end date in the product timezone. The end date is inclusive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the rate is applicable until the end of the loan."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"id":{"description":"Unique identifier of the interest or promo rate.","readOnly":true,"type":"string"},"setAtActivation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the rate was set at loan activation. Rates set at activation cannot be removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without a special permission. Rates set after activation are set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and do not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require a special permission for removal."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"startDate":{"description":"The rate start date in the product timezone. The start date is inclusive.","format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the rate is active."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the rate is inactive as it was removed."},"children":[]}]}]}],"enum":["active","inactive"],"type":"string"},"type":{"enum":["interestRate","promoRate"],"readOnly":true,"type":"string"}},"required":["annualRate","startDate"],"type":"object"}},"components/schemas/InterestRate":{"id":"components/schemas/InterestRate","kind":"json-schema","title":"Interest rate","data":{"allOf":[{"$ref":"#/components/schemas/LoanRate"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An interest rate on a loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will treat the provided value according on the interest type that was set at the time of origination (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atOrigination.interestType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remind, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can have one of the following values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use the value as provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute without adding the Index Interest Rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative interest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is outside of the range defined on the loan type, the system will accept the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but will return a warning in the response's object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratesValidation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will calculate an absolute rate by adding the relative loan rate (aka spread) provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest Rate is not set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will assume that the Index Interest Rate value is zero on the date the interest is accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative interest spread "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is allowed, but the system will default to zero if the addition of the Index Interest Rate still results in a negative rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the calculated absolute rate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (aka spread) plus Index Interest Rate, is outside of the range defined on the loan type, the system will accept the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but will return a warning in the response's object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratesValidation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"title":"Interest rate"}},"components/schemas/InterestRateResponse":{"id":"components/schemas/InterestRateResponse","kind":"json-schema","title":"InterestRateResponse","data":{"allOf":[{"$ref":"#/components/schemas/InterestRate"},{"properties":{"interestType":{"default":"absolute","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest type. The interest type cannot be changed after the loan status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and onward."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will calculate an absolute rate by adding the relative loan rate (aka spread)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided here to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate is not set, the system will assume that the Index Interest Rate value is zero on the date the interest is accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use the value as provided here without adding the Index Interest Rate."},"children":[]}]}]}],"enum":["absolute","spread"],"type":"string"}},"type":"object"}]}},"components/schemas/PromoRate":{"id":"components/schemas/PromoRate","kind":"json-schema","title":"Promo rate","data":{"allOf":[{"$ref":"#/components/schemas/LoanRate"}],"description":"A promo rate on a loan. If the annual interest rate is 0.25 and the promo rate for the corresponding\nperiod is 0.05, the net interest rate after application of the promo rate would be 0.2.\n","title":"Promo rate"}},"components/schemas/isEndExistingRatesFlag":{"id":"components/schemas/isEndExistingRatesFlag","kind":"json-schema","title":"isEndExistingRatesFlag","data":{"properties":{"isEndExistingRates":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the system will set all existing rates that have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the new rate's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus one calendar day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this flag carefully as it might impact ALL existing rates. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A loan has one existing rate of 0.05 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate=2021-07-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new rate of 0.01 is added with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate=2021-08-05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isEndExistingRates=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate of 0.05 will be updated, and the end date will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=2021-08-04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only rates with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be updated. If an existing rate has a defined end date, that rate will not be modified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an existing rate has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to the new rate, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will invalidate the existing rate vs. setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the new rate's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus one calendar day. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A loan has one existing rate of 0.05 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate=2025-10-02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate=null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new rate of 0.01 is added with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate=2025-10-02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isEndExistingRates=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate of 0.05 will be invalidated because the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-10-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/InterestRateValidationAfterOrig":{"id":"components/schemas/InterestRateValidationAfterOrig","kind":"json-schema","title":"InterestRateValidationAfterOrig","data":{"properties":{"interestRateBelowMinOrZero":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interest rate is below the minimum interest rate."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"interestRateExceedsMax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interest rate exceeds the maximum interest rate."},"children":[]}]}]}],"readOnly":true,"type":"boolean"}},"type":"object"}},"components/schemas/DueDatesRequest":{"id":"components/schemas/DueDatesRequest","kind":"json-schema","title":"DueDatesRequest","data":{"properties":{"agreementDocumentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document descriptor ID corresponding to the accepted loan term change agreement. This is required unless"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isShowRevisedTermsOnFrequencyChange=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the loan type."},"children":[]}]}]}],"type":"string"},"caseId":{"description":"An identifier for an existing case.\n","type":"string"},"dueDatesFrequency":{"default":"monthly","description":"The frequency of due dates.","enum":["weekly","everyTwoWeeks","twiceMonthly","monthly","singleTerm"],"type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change, and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"$ref":"#/components/schemas/SendNoticeCancelAutopay"},"specificDays":{"$ref":"#/components/schemas/SpecificDays"}},"type":"object"}},"components/schemas/LoanFee":{"id":"components/schemas/LoanFee","kind":"json-schema","title":"LoanFee","data":{"properties":{"amount":{"description":"The fee amount.","format":"float","type":"number"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamps.createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".**"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the fee was created. Fees in scheduled status have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFeeDetails.chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are not yet in the ledger. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are created and charged on the same day. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but charged later."},"children":[]}]}]}],"format":"date","type":"string"},"dueDate":{"description":"The date on which the fee is due.","format":"date","type":"string"},"dynamicFeeDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details about the fee. This object was historically used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only, but now it is used for all fee types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some attributes in this object are applicable only to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please carefully read the description of each attribute."},"children":[]}]}]}],"properties":{"apiName":{"$ref":"#/components/schemas/FeeApiName"},"canceledBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who canceled the fee."},"children":[]}]}]}],"type":"string"},"canceledDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a fee was canceled in the product timezone. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an uncanceled fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"format":"date","type":"string"},"capitalizedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of fee that was capitalized. Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can happen for a few reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee amount was changed and the loan was replayed. In that case, both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes are not used. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Part or all of the fee amount was capitalized. In that case, the capitalized amount is represented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Part or all of the fee amount was \"covered\" by a credit amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available on the line of credit. In that case, the credited amount is represented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees. Only applicable to lines of credit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the follow equation should be true:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount - amount = capitalizedAmount + creditedAmount"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"chargeDate":{"description":"The date a fee was charged to the ledger in the product timezone.","format":"date","type":"string"},"createdBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"type":"string"},"creditedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the fee that was \"covered\" by a credit amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available on the line of credit. Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can happen for a few reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee amount was changed and the loan was replayed. In that case, both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes are not used. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Part or all of the fee amount was capitalized. In that case, the capitalized amount will be represented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Part or all of the fee amount was \"covered\" by a credit amount (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available on the line of credit. In that case, the credited amount will be represented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. Only applicable to lines of credit. This is only possible for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capitalizedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the follow equation should be true:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount - amount = capitalizedAmount + creditedAmount"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"displayName":{"$ref":"#/components/schemas/FeeDisplayName"},"loanFeeExternalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender's external identifier of the loan fee object in the system, can also be used to cancel the fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"type":"string"},"loanFeeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the loan fee in the system, used to cancel a fee if necessary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"type":"string"},"purchaseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the line of credit draw's purchase; only relevant for the following fee types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignTransactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"type":"string"},"transactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the transaction; only relevant for the following fee types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nsfFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=dynamicFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee."},"children":[]}]}]}],"type":"string"}},"type":"object"},"loanId":{"$ref":"#/components/schemas/AnyId","description":"The identifier of the loan that the fee is charged on."},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original fee amount is calculated as the lower of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original fee amount when the fee was charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated amount if \"Update dynamic fee\" was called and originalAmount was passed. The updated amount cannot be higher than the amount when the fee was charged."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sometimes fee amounts are adjusted, such as when a borrower pays off the fee before the statement date, as well as when the borrower has an overpayment in the ledger."},"children":[]}]}]}]}],"format":"float","type":"number"},"scheduledDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the fee is expected to be charged. This date is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date should be used only for fees in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee is expected to be charged in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee was charged and is in the ledger."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- the fee was charged, but the amount might have changed since it was booked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the fee was canceled, and the borrower is no longer expected to pay it."},"children":[]}]}]}]}],"enum":["scheduled","booked","modified","canceled"],"type":"string"},"timestamps":{"properties":{"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the fee was created in the system. Created does not mean booked / charged."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicFeeDetails.chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is because the fee is not in the ledger yet."},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"},"type":{"enum":["originationFee","drawFee","dynamicFee"],"type":"string"}},"type":"object"}},"components/schemas/FeesMigrationDetails":{"id":"components/schemas/FeesMigrationDetails","kind":"json-schema","title":"FeesMigrationDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees migration related details. This object should be used for lines that are migrated from another system to Peach."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't use it for installment loan migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not double-count fees: a fee you charge on the LOC or a regular (non-static) draw with a charge date on or after the \"migration cutoff date\" is charged live and writes itself to the ledger. Do not also include its amount in the migration balances ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the LOC or draw, or the borrower will be billed twice. Historical fees dated on or before the cutoff and posted on the static \"migration\" draw are read-only and do not write to the ledger."},"children":[]}]}]}],"properties":{"originalDrawId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw identifier. Can be Peach or lender's external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All past fees prior to the \"migration cutoff date\" will be posted on the \"migration\" draw. After the \"migration cutoff date\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a lender can have multiple draws (e.g. Purchases, Cash Withdrawals, etc.). Use this attribute to indicate the original"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"draw ID that the fee was posted on in another system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case of fee cancellation after the \"migration cutoff date\", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used to adjust the draw balance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees can be posted on the line or draw level. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty, the system will assume that the fee was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originally charged on the line level."},"children":[]}]}]}],"nullable":true,"pattern":"^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string"},"originalPurchaseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchase identifier. Can be Peach or lender's external identifier. Use this attribute to indicate the original purchase ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the fee was associated with in another system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to the following fee types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignTransactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalPurchaseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for those fee types."},"children":[]}]}]}],"type":"string"},"originalTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction identifier. Can be Peach or lender's external identifier. Use this attribute to indicate the original"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction ID (in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status) that the fee was associated with in another system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to the following fee types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nsfFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided for those fee types."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/LoanInvestors":{"id":"components/schemas/LoanInvestors","kind":"json-schema","title":"Investors","data":{"properties":{"effectiveDate":{"description":"The date at which this ownership structure came into effect.","format":"date","type":"string"},"investors":{"items":{"$ref":"#/components/schemas/LoanInvestor"},"type":"array"}},"title":"Investors","type":"object"}},"components/schemas/LocChangeLoanTermsSCRAUpdate":{"id":"components/schemas/LocChangeLoanTermsSCRAUpdate","kind":"json-schema","title":"LocChangeLoanTermsSCRAUpdate","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"endDate":{"description":"The new end date for the SCRA period. The end date is inclusive.\nMust be within the loan's lifetime, after the start date, and must not overlap with other SCRA plans.\n","format":"date","type":"string"},"rateId":{"description":"The public ID of the SCRA interest rate to modify.","type":"string"},"sendNotice":{"default":true,"deprecated":true,"description":"Deprecated. This parameter is accepted for backwards compatibility but has no effect.\nNotices are always sent.\n","type":"boolean"},"startDate":{"description":"The new start date for the SCRA period. The start date is inclusive.\nMust be within the loan's lifetime and must not overlap with other SCRA plans.\n","format":"date","type":"string"}},"required":["rateId","startDate","endDate"],"type":"object"}},"components/schemas/LocChangeLoanTermsSCRA":{"id":"components/schemas/LocChangeLoanTermsSCRA","kind":"json-schema","title":"LocChangeLoanTermsSCRA","data":{"properties":{"annualRate":{"default":0.06,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"endDate":{"description":"The end date of the period. The end date is inclusive.\n","format":"date","type":"string"},"isCancelFees":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will waive any fees that were charged during the period."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"default":true,"deprecated":true,"description":"Deprecated. This parameter is accepted for backwards compatibility but has no effect.\nNotices are always sent.\n","type":"boolean"},"startDate":{"description":"The start date of the period. The start date is inclusive.\n","format":"date","type":"string"}},"required":["startDate","endDate"],"type":"object"}},"components/schemas/BasePastPeriod":{"id":"components/schemas/BasePastPeriod","kind":"json-schema","title":"BasePastPeriod","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"dueDate":{"description":"The period's payment due date.","format":"date","nullable":false,"type":"string"},"endDate":{"description":"The period end date. The end date is inclusive.","format":"date","nullable":false,"type":"string"},"gracePeriod":{"nullable":true,"properties":{"fullBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"sealed\" (aka when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOpen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit (and Draw) obligations are \"sealed\" on the statement date."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"nullable":true,"type":"number"},"fullBalanceMinusOverdueAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is the full statement balance amount (also called \"new balance\") minus any overdue amount as of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date when the obligation is \"sealed\" (aka when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOpen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Line of credit (and Draw) obligations are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"sealed\" on the statement date."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"nullable":true,"type":"number"},"isGracePeriodEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period status of the obligation period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period was not eligible for the grace period benefit and interest accrued in the period."},"children":[]}]}]}],"type":"boolean"},"totalFulfilledOnDueDateAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is only used for grace period benefit logic. The value will be set one calendar day after the due date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due date. This is a sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilledAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overpaymentsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"nullable":true,"type":"number"}},"type":"object"},"startDate":{"description":"The period start date. The start date is inclusive.","format":"date","nullable":false,"type":"string"},"statementDate":{"description":"The date when a statement for the period was created or should be created in the future.","format":"date","nullable":false,"type":"string"}},"type":"object"}]}},"components/schemas/Statement":{"id":"components/schemas/Statement","kind":"json-schema","title":"Statement","data":{"properties":{"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that a lender owes to the borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Peach system does not allow negative balances. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to represent credit balance owed to the borrower."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"documentDescriptorId":{"description":"The statement's document descriptor ID.\n","nullable":true,"type":"string"},"minimumAmountDue":{"description":"The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest\naccrued, fees and part of a principal. This amount does not net any payments or service credits made in the period.\n","format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"newBalanceAmount":{"description":"The new balance amount for the period.","format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"type":"object"}},"components/schemas/PastPeriod":{"id":"components/schemas/PastPeriod","kind":"json-schema","title":"PastPeriod","data":{"allOf":[{"$ref":"#/components/schemas/BasePastPeriod"},{"properties":{"statement":{"$ref":"#/components/schemas/Statement"}},"type":"object"}]}},"components/schemas/StatementWithRequired":{"id":"components/schemas/StatementWithRequired","kind":"json-schema","title":"StatementWithRequired","data":{"properties":{"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that a lender owes to the borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Peach system does not allow negative balances. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to represent credit balance owed to the borrower."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"documentDescriptorId":{"description":"The statement's document descriptor ID.\n","nullable":true,"type":"string"},"minimumAmountDue":{"description":"The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest\naccrued, fees and part of a principal. This amount does not net any payments or service credits made in the period.\n","format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"newBalanceAmount":{"description":"The new balance amount for the period.","format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["minimumAmountDue","newBalanceAmount"],"type":"object"}},"components/schemas/PastPeriodWithRequireds":{"id":"components/schemas/PastPeriodWithRequireds","kind":"json-schema","title":"PastPeriodWithRequireds","data":{"allOf":[{"$ref":"#/components/schemas/PastPeriod"},{"properties":{"statement":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/StatementWithRequired"}]}},"required":["startDate","endDate","statementDate","dueDate","statement"],"type":"object"}]}},"components/schemas/TransactionStatusReadOnly":{"id":"components/schemas/TransactionStatusReadOnly","kind":"json-schema","title":"TransactionStatusReadOnly","data":{"enum":["scheduled","initiated","pending","succeeded","failed","canceled","inDispute","chargeback"],"type":"string"}},"components/schemas/PastTransactionMigrationDetails":{"id":"components/schemas/PastTransactionMigrationDetails","kind":"json-schema","title":"Migration details","data":{"properties":{"migration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction migration related details. This object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used only for transactions with an effective date before the \"migration cutoff date\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used for lines that are migrated from another system to Peach. Don't use it for installment loan migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to pass details on how a transaction was applied/allocated to draws."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit had three draws prior to the \"migration cutoff date\". Balances of draws were:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw A: $650"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw B: $70"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw B: $0"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment of $120 was processed. Using this object you can tell the system that $120 was waterfalled/allocated as following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw A split: $70"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw B split: $50"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draw A split: $0"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, then you won't be able to make the following status changes after the \"migration cutoff date\":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]}]}]}],"properties":{"drawSplitDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction draw level split details are useful if the lender expects failures of previous successful transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a transaction is applied on the line of credit level, it flows according to the payment waterfall configuration across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple draws. At least one element in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawSplitDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is required."},"children":[]}]}]}],"items":{"properties":{"drawAllocatedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portion/split of the transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was applied/allocated to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" draw. The sum of all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawAllocatedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the transaction fails after the \"migration cutoff date\", the system will increase the applicable \"originalDrawId\" draw's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-due principal balance and replay the line."},"children":[]}]}]}],"format":"float","type":"number"},"originalDrawId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw identifier. Can be Peach or lender's external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All past transactions prior to the \"migration cutoff date\" will be posted on the \"migration\" draw. After the \"migration cutoff date\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a lender can have multiple draws (e.g. Purchases, Cash Withdrawals, etc.) Use this attribute to indicate the original draw ID that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the transaction was posted on in another system. In case of transaction failure after the \"migration cutoff date\", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalDrawId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be used to increase the draw's \"non-due principal\" balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions can be posted on the line or draw level. If the transaction was originally posted on the draw level, choose one of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"post migration draws (e.g. Purchases)."},"children":[]}]}]}],"pattern":"^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"title":"Migration details","type":"object"}},"components/schemas/PastTransactionResponse":{"id":"components/schemas/PastTransactionResponse","kind":"json-schema","title":"PastTransactionResponse","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"$ref":"#/components/schemas/PastTransactionMigrationDetails"}]}},"components/schemas/PastTransactionsPaging":{"id":"components/schemas/PastTransactionsPaging","kind":"json-schema","title":"Past transactions","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PastTransactionResponse"},"type":"array"}},"type":"object"}],"title":"Past transactions"}},"components/schemas/TransactionMetaData":{"id":"components/schemas/TransactionMetaData","kind":"json-schema","title":"TransactionMetaData","data":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"}},"components/schemas/BaseOneTimePaymentTransaction":{"id":"components/schemas/BaseOneTimePaymentTransaction","kind":"json-schema","title":"One Time Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"actualAmount":{"description":"The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n","readOnly":true,"type":"number"},"amount":{"description":"The amount of the payment.\n","format":"float","minimum":0,"type":"number","writeOnly":true},"createdBy":{"description":"Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n","readOnly":true,"type":"integer"},"customDisplayName":{"description":"A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n","nullable":true,"type":"string"},"evidenceDocumentId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID of a one-time payment consent screenshot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"captured when a borrower made the payment.  Only applicable when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach App is used and company's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.evidence.captureScreenshot=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"externalId":{"$ref":"#/components/schemas/externalId","description":"A lender's identifier for a transaction."},"failureReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction failure reason. This value is ignored except when creating an external transaction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=failed"},"children":[]}]}]}],"enum":["insufficientFunds","chargeback","accountClosed","invalidAccount","unknownReason","invalidCvv","invalidExpirationDate","avsFailed","networkError","cardDeclined","accountFrozen","deceased","invalidRouting","paymentStopped","incorrectNumber","fraudulent","unauthorizedDebit"],"type":"string"},"metaData":{"$ref":"#/components/schemas/TransactionMetaData"},"paymentInstrumentId":{"$ref":"#/components/schemas/AnyId","description":"The payment instrument identifier that was charged."},"scheduledAmount":{"description":"The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n","readOnly":true,"type":"number"},"type":{"enum":["oneTime"],"type":"string","writeOnly":true}},"required":["amount","type"],"type":"object"}],"title":"One Time Payment"}},"components/schemas/PastTransactionCreationStatus":{"id":"components/schemas/PastTransactionCreationStatus","kind":"json-schema","title":"PastTransactionCreationStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction status. May only be passed when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External transactions can be created in: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External transactions are applied to the loan balance immediately when created with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they will be applied the first time they are updated to one of these statuses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment failed and was removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then. Disputed payment can be for partial amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was canceled. Payment can be canceled only if the current status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount."},"children":[]}]}]}],"enum":["initiated","pending","succeeded","failed","canceled","inDispute","chargeback"],"type":"string"}},"components/schemas/BasePastTransaction":{"id":"components/schemas/BasePastTransaction","kind":"json-schema","title":"Base Past Transaction","data":{"allOf":[{"properties":{"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans will be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the transaction in the product timezone. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDateTimeInUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to interpret as UTC instead. This attribute can be used for transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date must be in the past or today. Make sure to provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveDateTimeInUtc":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are interpreted as UTC"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rather than the product timezone. This avoids ambiguity during DST transitions."},"children":[]}]}]}],"type":"boolean"},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDateTimeInUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to interpret as UTC instead. This attribute can be used for transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only, the value must be after 2AM in the product timezone."},"children":[]}]}]}],"type":"object","writeOnly":true}]},"paymentInstrumentDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instrument details are only allowed to be passed for migrated lines of credit. This allows you to create transactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without the need to create a payment instrument object first. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Instead, the system will automatically create a payment instrument behind the scenes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The instrument will be created as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrumentType=paymentNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and mainly used to be displayed in the Borrower Portal or an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App. The instrument cannot be used for any future transactions after the migration."},"children":[]}]}]}],"properties":{"accountLastFour":{"description":"The last four digits of the payment instrument, check number, wire number, money order serial number or custom.\n","maxLength":4,"minLength":4,"nullable":true,"type":"string"},"customDisplayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrumentType=custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The system will show the payment method as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{customerDisplayName} *{accountLastFour}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerDisplayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be adjusted automatically to uppercase. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountLastFour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, the system will only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"show the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{customerDisplayName}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 1:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = custom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerDisplayName = Cash"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 2:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = bankAccount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = 8892"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK ACCOUNT *8892"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 3:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = debitCard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = 7098"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT CARD *7098"},"children":[]}]}]}],"nullable":true,"type":"string"},"type":{"description":"The instrument type.","enum":["bankAccount","creditCard","debitCard","check","payroll","moneyOrder","wire","custom"],"type":"string"}},"type":"object"}},"required":["effectiveDate","effectiveTimeOfDay"],"type":"object"},{"$ref":"#/components/schemas/PastTransactionMigrationDetails"}],"title":"Base Past Transaction"}},"components/schemas/PastTransactionOneTimePayment":{"id":"components/schemas/PastTransactionOneTimePayment","kind":"json-schema","title":"One Time Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseOneTimePaymentTransaction"},{"properties":{"status":{"$ref":"#/components/schemas/PastTransactionCreationStatus"}},"required":["status"],"type":"object"},{"$ref":"#/components/schemas/BasePastTransaction"}],"title":"One Time Payment"}},"components/schemas/BaseServiceCreditTransaction":{"id":"components/schemas/BaseServiceCreditTransaction","kind":"json-schema","title":"Service Credit","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"actualAmount":{"description":"The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n","format":"float","readOnly":true,"type":"number"},"amount":{"description":"The amount to credit the borrower's balance.\n","format":"float","minimum":0,"type":"number","writeOnly":true},"createdBy":{"description":"Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n","readOnly":true,"type":"integer"},"customDisplayName":{"description":"A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n","nullable":true,"type":"string"},"externalId":{"$ref":"#/components/schemas/externalId"},"metaData":{"$ref":"#/components/schemas/TransactionMetaData"},"scheduledAmount":{"description":"The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n","format":"float","readOnly":true,"type":"number"},"serviceCreditSponsor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sponsor of the credit. Mainly used for ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOwner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as expense in ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanServicer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as liability from the servicer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit is recorded as liability from the merchant."},"children":[]}]}]}],"enum":["loanOwner","loanServicer","merchant"],"type":"string"},"serviceCreditType":{"$ref":"#/components/schemas/serviceCreditTypes","description":"Type of the credit. Credit types are recorded differently in ledger/accounting."},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was scheduled for a future date that has not arrived yet. The payment has not applied to a loan yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment failed and was removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then. Disputed payment can be for partial amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was canceled. Payment can be canceled only if the current status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount."},"children":[]}]}]}],"enum":["scheduled","initiated","pending","succeeded","failed","canceled","inDispute","chargeback"],"readOnly":true,"type":"string"},"timestamps":{"description":"Timestamps of the transaction statuses.","properties":{"canceledAt":{"format":"date-time","type":"string"},"chargebackAt":{"format":"date-time","type":"string"},"effectiveDate":{"format":"date","type":"string"},"failedAt":{"format":"date-time","type":"string"},"inDisputeAt":{"format":"date-time","type":"string"},"initiatedAt":{"format":"date-time","type":"string"},"pendingAt":{"format":"date-time","type":"string"},"scheduledDate":{"format":"date","type":"string"},"succeededAt":{"format":"date-time","type":"string"}},"readOnly":true,"type":"object"},"type":{"enum":["service"],"type":"string","writeOnly":true}},"required":["amount","type","serviceCreditType","serviceCreditSponsor"],"type":"object"}],"title":"Service Credit"}},"components/schemas/PastTransactionServiceCredit":{"id":"components/schemas/PastTransactionServiceCredit","kind":"json-schema","title":"Service Credit","data":{"allOf":[{"$ref":"#/components/schemas/BaseServiceCreditTransaction"},{"$ref":"#/components/schemas/BasePastTransaction"}],"title":"Service Credit"}},"components/schemas/BaseDownPaymentTransaction":{"id":"components/schemas/BaseDownPaymentTransaction","kind":"json-schema","title":"Down Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"actualAmount":{"description":"The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n","readOnly":true,"type":"number"},"amount":{"description":"The amount of the payment.\n","format":"float","minimum":0,"type":"number","writeOnly":true},"createdBy":{"description":"Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n","readOnly":true,"type":"integer"},"customDisplayName":{"description":"A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n","nullable":true,"type":"string"},"externalId":{"$ref":"#/components/schemas/externalId","description":"A lender's identifier for a transaction."},"metaData":{"$ref":"#/components/schemas/TransactionMetaData"},"paymentInstrumentId":{"$ref":"#/components/schemas/AnyId","description":"The payment instrument identifier that was charged."},"scheduledAmount":{"description":"The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n","readOnly":true,"type":"number"},"type":{"enum":["downPayment"],"type":"string","writeOnly":true}},"required":["amount","type"],"type":"object"}],"title":"Down Payment"}},"components/schemas/PastTransactionDownPayment":{"id":"components/schemas/PastTransactionDownPayment","kind":"json-schema","title":"Down Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseDownPaymentTransaction"},{"properties":{"status":{"$ref":"#/components/schemas/PastTransactionCreationStatus"}},"required":["status"],"type":"object"},{"$ref":"#/components/schemas/BasePastTransaction"}],"title":"Down Payment"}},"components/schemas/PastTransaction":{"id":"components/schemas/PastTransaction","kind":"json-schema","title":"PastTransaction","data":{"oneOf":[{"$ref":"#/components/schemas/PastTransactionOneTimePayment"},{"$ref":"#/components/schemas/PastTransactionServiceCredit"},{"$ref":"#/components/schemas/PastTransactionDownPayment"}]}},"components/schemas/BasePastTransactionForUpdate":{"id":"components/schemas/BasePastTransactionForUpdate","kind":"json-schema","title":"Update Past Transaction","data":{"allOf":[{"properties":{"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans will be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the transaction in the product timezone. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDateTimeInUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to interpret as UTC instead. This attribute can be used for transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date must be in the past or today. Make sure to provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveDateTimeInUtc":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are interpreted as UTC"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rather than the product timezone. This avoids ambiguity during DST transitions."},"children":[]}]}]}],"type":"boolean"},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDateTimeInUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to interpret as UTC instead. This attribute can be used for transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only, the value must be after 2AM in the product timezone."},"children":[]}]}]}],"type":"object","writeOnly":true}]},"paymentInstrumentDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instrument details are only allowed to be passed for migrated lines of credit. This allows you to create transactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without the need to create a payment instrument object first. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the system will not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Instead, the system will automatically create a payment instrument behind the scenes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The instrument will be created as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrumentType=paymentNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and mainly used to be displayed in the Borrower Portal or an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App. The instrument cannot be used for any future transactions after the migration."},"children":[]}]}]}],"properties":{"accountLastFour":{"description":"The last four digits of the payment instrument, check number, wire number, money order serial number or custom.\n","maxLength":4,"minLength":4,"nullable":true,"type":"string"},"customDisplayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrumentType=custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The system will show the payment method as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{customerDisplayName} *{accountLastFour}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerDisplayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be adjusted automatically to uppercase. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountLastFour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, the system will only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"show the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{customerDisplayName}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 1:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = custom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerDisplayName = Cash"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 2:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = bankAccount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = 8892"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK ACCOUNT *8892"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 3:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrumentType = debitCard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountLastFour = 7098"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displayed as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT CARD *7098"},"children":[]}]}]}],"nullable":true,"type":"string"},"type":{"description":"The instrument type.","enum":["bankAccount","creditCard","debitCard","check","payroll","moneyOrder","wire","custom"],"type":"string"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PastTransactionMigrationDetails"}],"title":"Update Past Transaction"}},"components/schemas/PastTransactionUpdate":{"id":"components/schemas/PastTransactionUpdate","kind":"json-schema","title":"PastTransactionUpdate","data":{"allOf":[{"$ref":"#/components/schemas/BasePastTransactionForUpdate"},{"properties":{"amount":{"description":"The amount of the payment.\n","format":"float","minimum":0,"type":"number"},"externalId":{"$ref":"#/components/schemas/externalId"},"failureReason":{"$ref":"#/components/schemas/TransactionFailureReason"},"status":{"$ref":"#/components/schemas/PastTransactionCreationStatus"}},"type":"object"}]}},"components/schemas/LOCMigrationBalances":{"id":"components/schemas/LOCMigrationBalances","kind":"json-schema","title":"LOCMigrationBalances","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balances passed here should be as of the \"migration cutoff date\" after the most recent statement was generated in your legal system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balances should be as of Aug 1, 2024 after the statement was generated on Aug 1, 2024."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not double-count fees: a fee you charge on the LOC or a regular (non-static) draw that it belongs to with a charge date on or after the \"migration cutoff date\" writes itself to the ledger. For any such fee, either include its amount in these balances OR charge it through the fees endpoint; never both, or the borrower will be billed twice."},"children":[]}]}]}],"properties":{"creditLimitAmount":{"description":"The line credit limit amount as of the \"migration cutoff date\".\n","format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due balances represent balances that are currently due."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fees can be passed inside the balance objects on LOC level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other balances are expected to be passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create migration period draw data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"properties":{"dueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"dueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["dueOriginationFeesAmount","dueLateFeesAmount"],"type":"object"},"nonDueBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-due balances represent balances that are not yet due."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fees can be passed inside the balance objects on LOC level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other balances are expected to be passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create migration period draw data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"properties":{"nonDueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"nonDueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonDueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["nonDueOriginationFeesAmount","nonDueLateFeesAmount"],"type":"object"},"overdueBalances":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdue balances represent balances that are overdue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fees can be passed inside the balance objects on LOC level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other balances are expected to be passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create migration period draw data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"properties":{"overdueLateFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"},"overdueOriginationFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination fees portion of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overdueFeesAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["overdueOriginationFeesAmount","overdueLateFeesAmount"],"type":"object"},"reimbursementAmount":{"description":"The total amount that a lender owes to the borrower as of the \"migration cutoff date\".\n","format":"float","minimum":0,"multipleOf":0.01,"type":"number"}},"required":["nonDueBalances","dueBalances","overdueBalances","creditLimitAmount","reimbursementAmount"],"type":"object"}},"components/schemas/LOCMigrationGracePeriod":{"id":"components/schemas/LOCMigrationGracePeriod","kind":"json-schema","title":"LOCMigrationGracePeriod","data":{"allOf":[{"$ref":"#/components/schemas/BaseMigrationGracePeriod"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not migrating past periods and the migration period is the first period of the LOC:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are migrating past periods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the entire LOC grace period details including all its draws."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the grace period data is part of the \"Create migration period LOC data\" vs \"Create past periods data\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The migration period is a \"live\" period in which you execute migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the Peach system needs to know if the LOC is eligible for the grace period benefit when the migration period starts, the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed here. If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will start migration without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accruing interest in the \"migration period\". If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will start migration with accruing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interest in the \"migration period\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the \"due date + 1\" within the \"migration period\", the system evaluates the grace eligibility based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullBalanceMinusOverdueAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and payments made."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you migrate the LOC before the upcoming \"due date\", the system will evaluate the grace period eligibility in \"live\" and might revoke the benefit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you migrate the LOC after the \"due date\", the system will evaluate the grace period eligibility as part of the \"replay/migration\" process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because of existing limitations with \"replay\", grace period eligibility cannot be revoked as part of the replay process. However, the replay"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process can reinstate the grace period benefit (in other words, waive accrued interest from the start of the \"migration period\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach is responsible for generating the statement corresponding to the migration period on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period details of the migration period will be calculated by the Peach system on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts and values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system."},"children":[]}]}]}]}]}]}],"type":"object"}]}},"components/schemas/MigrationPeriod":{"id":"components/schemas/MigrationPeriod","kind":"json-schema","title":"MigrationPeriod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The migration period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"migration cutoff date\" will be set to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed here. It's important to understand that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are future dates. The previous period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also a future date (relative to when you execute the migration) and falls in the \"migration period\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Migration cutoff date\" is Aug 1, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you execute the migration on Aug 10, 2024, the \"migration at date\" is Aug 10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Aug 22, 2024, falls in the \"migration period\" that starts on Aug 1, 2024 and ends on Aug 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming due date is Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you didn't complete the migration before Aug 22, 2024, you need to cancel the loan and start the process again."},"children":[]}]}]}]}]}]}],"properties":{"dueDate":{"format":"date","nullable":false,"type":"string"},"endDate":{"format":"date","nullable":false,"type":"string"},"id":{"readOnly":true,"type":"string"},"object":{"default":"loanPeriod","enum":["loanPeriod"],"readOnly":true,"type":"string"},"startDate":{"format":"date","nullable":false,"type":"string"},"statementDate":{"format":"date","nullable":false,"type":"string"}},"required":["startDate","endDate","statementDate","dueDate"],"type":"object"}},"components/schemas/LOCMigrationObligation":{"id":"components/schemas/LOCMigrationObligation","kind":"json-schema","title":"LOCMigrationObligation","data":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not migrating past periods and the migration period is the first period of the LOC:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are migrating past periods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the LOC level obligation details only (excluding any draws)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should've already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the additional obligation data is part of the \"Create migration period LOC data\" vs \"Create past periods data\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remind, the migration period is a \"live\" period in which you execute migration. The obligation details of the migration period will be calculated by the Peach system. Peach is also responsible for generating the statement corresponding to the migration period on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationPeriod.statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The obligation details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts and other values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system."},"children":[]}]}]}]}]}]}],"properties":{"migratedDaysOverdue":{"$ref":"#/components/schemas/MigratedDaysOverdue"},"migratedOverdueFromDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date from which the account is overdue at the time of migration. This attribute will also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be used to calculate \"Date Of First Delinquency\" for credit bureaus reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedDaysOverdue > 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migratedOverdueFromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"format":"date","nullable":true,"type":"string"},"obligationAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining amount of the previous period's obligation that a borrower needs to pay on the due date that comes after \"migration cutoff date\". The remaining amount should be as of \"migration cutoff date\" vs. \"migration at date\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the LOC level remaining obligation amount excluding any draws' obligation amounts. Only fees can be passed inside the balance objects on LOC level. All other balances are expected to be passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create migration period draw data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your LOC (or credit card) product doesn't count payments that were made before the statement date towards the statement minimum amount, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be always equal to the LOC level portion of the whole statement minimum amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Aug 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Sep 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Sep 22, 2024"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous period (also called \"past period\"):"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startDate: Jul 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endDate: Jul 31, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate: Aug 1, 2024"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate: Aug 22, 2024"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 1:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A late fee of $15 was charged in the previous period on Jul 23, 2024 (on the LOC level). This fee is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, $5 out of $15 of the late fee was paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining fee amount of $10 is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 2:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A late fee of $15 was charged in the previous period on Jul 23, 2024 (on LOC level). This fee is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, none of the payments were counted toward the $15 late fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The late fee amount of $15 is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario 3:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A late fee of $15 was charged in the previous period on Jul 23, 2024 (on LOC level). This fee is due on Aug 22, 2024."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A borrower made early payments in the previous period, and based on your waterfall configuration in the legacy system, the payments were counted toward the $15 late fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining fee amount of $0 is due on Aug 22, 2024 (in other words, the borrower doesn't need to pay anything on Aug 22, 2024.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligationAmount=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"float","minimum":0,"multipleOf":0.01,"nullable":false,"type":"number"}},"required":["obligationAmount","migratedDaysOverdue"],"type":"object"}]}},"components/schemas/MigrationPeriodLOCData":{"id":"components/schemas/MigrationPeriodLOCData","kind":"json-schema","title":"MigrationPeriodLOCData","data":{"properties":{"balances":{"$ref":"#/components/schemas/LOCMigrationBalances"},"gracePeriod":{"$ref":"#/components/schemas/LOCMigrationGracePeriod"},"migrationPeriod":{"$ref":"#/components/schemas/MigrationPeriod"},"obligation":{"$ref":"#/components/schemas/LOCMigrationObligation"},"paidOffDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the line was paid off in another system (not in Peach). Required only when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postMigrationLoanStatus=paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be after the line activation date and before the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"migration cutoff date. Not allowed when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postMigrationLoanStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","nullable":false,"type":"string"},"postMigrationLoanChargedOffReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for the line charge off. Only required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"migrationStatus=chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off per loan type configuration after X days overdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudulent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off for a fraudulent reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of bankruptcy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of some legal reason."},"children":[]}]}]}]}],"enum":["term","fraudulent","bankruptcy","legal"],"nullable":true,"type":"string"},"postMigrationLoanStatus":{"default":"active","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the line after a successful migration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will first migrate the line as \"active\" and then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"immediately accelerate or charge off the line and its draws. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the acceleration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or charge off will be equal to the \"migration cutoff date\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the line is migrated as a static line that can never transition to any other status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obligation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postMigrationLoanStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","accelerated","chargedOff","paidOff"],"type":"string"}},"type":"object"}},"components/schemas/MigrationPeriodLOCDataResponse":{"id":"components/schemas/MigrationPeriodLOCDataResponse","kind":"json-schema","title":"MigrationPeriodLOCDataResponse","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/MigrationPeriodLOCData"},{"properties":{"migratedOverdueAmount":{"format":"float","nullable":true,"type":"number"}},"type":"object"}]}},"type":"object"}]}},"components/schemas/MigrationPeriodLOCDataPaidOffWithRequired":{"id":"components/schemas/MigrationPeriodLOCDataPaidOffWithRequired","kind":"json-schema","title":"MigrationPeriodLOCDataPaidOffWithRequired","data":{"properties":{"migrationPeriod":{"$ref":"#/components/schemas/MigrationPeriod"},"paidOffDate":{"format":"date","type":"string"},"postMigrationLoanStatus":{"enum":["paidOff"],"type":"string"}},"required":["migrationPeriod","paidOffDate","postMigrationLoanStatus"],"type":"object"}},"components/schemas/MigrationPeriodLOCDataActiveWithRequired":{"id":"components/schemas/MigrationPeriodLOCDataActiveWithRequired","kind":"json-schema","title":"MigrationPeriodLOCDataActiveWithRequired","data":{"allOf":[{"$ref":"#/components/schemas/MigrationPeriodLOCData"},{"required":["migrationPeriod","obligation","gracePeriod","balances"],"type":"object"}]}},"components/schemas/MigrationPeriodLOCDataWithRequired":{"id":"components/schemas/MigrationPeriodLOCDataWithRequired","kind":"json-schema","title":"MigrationPeriodLOCDataWithRequired","data":{"oneOf":[{"$ref":"#/components/schemas/MigrationPeriodLOCDataPaidOffWithRequired"},{"$ref":"#/components/schemas/MigrationPeriodLOCDataActiveWithRequired"}]}},"components/schemas/ObligationLoanGracePeriod":{"id":"components/schemas/ObligationLoanGracePeriod","kind":"json-schema","title":"ObligationLoanGracePeriod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loan's grace period details. Only Loans created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will populate details in this object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gracePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object for Draw-specific grace period details."},"children":[]}]}]}],"nullable":true,"properties":{"fullBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"sealed\" (aka when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOpen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line of credit (and Draw) obligations are \"sealed\" on the statement date."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"fullBalanceMinusOverdueAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute is only used for grace period benefit logic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount is the full statement balance amount (also called \"new balance\") minus any overdue amount as of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date when the obligation is \"sealed\" (aka when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isOpen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Line of credit (and Draw) obligations are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"sealed\" on the statement date."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"isGracePeriodEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grace period status of the obligation period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - means that the period was not eligible for the grace period benefit and interest accrued in the period."},"children":[]}]}]}],"type":"boolean"},"totalFulfilledOnDueDateAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is only used for grace period benefit logic. The value will be set one calendar day after the due date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due date. This is a sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilledAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overpaymentsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"}},"type":"object"}},"components/schemas/LOCObligationResult":{"id":"components/schemas/LOCObligationResult","kind":"json-schema","title":"LOCObligationResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/ObligationAmountFields"},{"$ref":"#/components/schemas/ObligationOtherFields"},{"properties":{"gracePeriod":{"anyOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draws' grace period details. Only draws that were created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isGracePeriodEligible=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be included in the list."},"children":[]}]}]}],"items":{"allOf":[{"properties":{"drawId":{"description":"The draw identifier.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ObligationGracePeriod"}]},"nullable":true,"type":"array"},{"$ref":"#/components/schemas/ObligationGracePeriod"}]},"loanGracePeriod":{"$ref":"#/components/schemas/ObligationLoanGracePeriod"}},"type":"object"}]}},"components/schemas/LOCObligationsResult":{"id":"components/schemas/LOCObligationsResult","kind":"json-schema","title":"LOCObligationsResult","data":{"allOf":[{"$ref":"#/components/schemas/IsLocked"},{"properties":{"daysOverdue":{"description":"Number of calendar days overdue starting from the due date of the earliest overdue obligation to\nthe current date.\n","type":"integer"},"isOverdue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower has any obligation overdue on the loan."},"children":[]}]}]}],"type":"boolean"},"obligations":{"items":{"$ref":"#/components/schemas/LOCObligationResult"},"type":"array"},"overdueAmount":{"description":"The total overdue amount across all obligations on the loan.\n","format":"float","type":"number"}},"type":"object"}]}},"components/schemas/LoanChangeLoanTerms":{"id":"components/schemas/LoanChangeLoanTerms","kind":"json-schema","title":"LoanChangeLoanTerms","data":{"allOf":[{"$ref":"#/components/schemas/DueDatesRequest"},{"properties":{"duration":{"description":"The remaining duration - in months starting from the current day - under the new payment plan.\n","type":"integer"},"recurringAmount":{"description":"The requested recurring amount under the new payment plan.\n","format":"float","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"components/schemas/schemas-SendNoticeCancelAutopay":{"id":"components/schemas/schemas-SendNoticeCancelAutopay","kind":"json-schema","title":"schemas-SendNoticeCancelAutopay","data":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanPaymentScheduleChanged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"components/schemas/LoanChangeLoanTermsSCRAUpdate":{"id":"components/schemas/LoanChangeLoanTermsSCRAUpdate","kind":"json-schema","title":"LoanChangeLoanTermsSCRAUpdate","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"endDate":{"description":"The new end date for the SCRA period. The end date is inclusive.\nMust be within the loan's lifetime, after the start date, and must not overlap with other SCRA plans.\n","format":"date","type":"string"},"rateId":{"description":"The public ID of the SCRA interest rate to modify.","type":"string"},"sendNotice":{"$ref":"#/components/schemas/schemas-SendNoticeCancelAutopay"},"startDate":{"description":"The new start date for the SCRA period. The start date is inclusive.\nMust be within the loan's lifetime and must not overlap with other SCRA plans.\n","format":"date","type":"string"}},"required":["rateId","startDate","endDate"],"type":"object"}},"components/schemas/LoanChangeLoanTermsSCRA":{"id":"components/schemas/LoanChangeLoanTermsSCRA","kind":"json-schema","title":"LoanChangeLoanTermsSCRA","data":{"properties":{"annualRate":{"default":0.06,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"endDate":{"description":"The end date of the period. The end date is inclusive.\n","format":"date","type":"string"},"isCancelFees":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will waive any fees that were charged during the period."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"$ref":"#/components/schemas/schemas-SendNoticeCancelAutopay"},"startDate":{"description":"The start date of the period. The start date is inclusive.\n","format":"date","type":"string"}},"required":["startDate","endDate"],"type":"object"}},"components/schemas/LoanPeriod":{"id":"components/schemas/LoanPeriod","kind":"json-schema","title":"LoanPeriod","data":{"properties":{"dueDate":{"description":"The period's payment due date in the product timezone.","format":"date","type":"string"},"endDate":{"description":"The period end date in the product timezone. The end date is inclusive.","format":"date","type":"string"},"id":{"description":"The period identifier.","type":"string"},"startDate":{"description":"The period start date in the product timezone. The start date is inclusive.","format":"date","type":"string"},"statementDate":{"description":"The date when a statement for the period was created or should be created in the future.","format":"date","type":"string"}},"type":"object"}},"components/schemas/LoanPeriodsPaging":{"id":"components/schemas/LoanPeriodsPaging","kind":"json-schema","title":"LoanPeriodsPaging","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanPeriod"},"type":"array"}},"type":"object"}},"components/schemas/ProcessingCompleteGeneric":{"id":"components/schemas/ProcessingCompleteGeneric","kind":"json-schema","title":"ProcessingCompleteGeneric","data":{"properties":{"processingComplete":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned when query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Indicates if the extra processing has finished yet."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If it is not done in 20 seconds, the request will return and this value will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/StatementSharedFields":{"id":"components/schemas/StatementSharedFields","kind":"json-schema","title":"StatementSharedFields","data":{"properties":{"billingCycleEndDate":{"description":"The end date of the statement billing cycle. This date is in the product timezone.","format":"date","type":"string"},"billingCycleStartDate":{"description":"The start date of the statement billing cycle. This date is in the product timezone.","format":"date","type":"string"},"documentDescriptorId":{"description":"The statement's document descriptor ID. To get the actual document, use the \"Download document content\" endpoint.\n","type":"string"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it means that the statement was originally calculated and created in another system (not in Peach) and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uploaded to the Peach system. Statements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might not have all statement details data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must upload a PDF version of the statement. Statements that are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be regenerated by Peach. The system will return an error if the regenerate statement endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is called for a statement with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it means that the statement was originally calculated and created by the Peach system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used in Line of Credit migration."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"minimumDueAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest accrued,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fees and part of a principal. This amount does not net any payments or service credits made in the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanType.statements.includeOverdueAmountInMinPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the minimum payment calculation will include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the minimum amount calculated for the closed period and overdue amount from previous periods."},"children":[]}]}]}],"format":"float","type":"number"},"newBalanceAmount":{"description":"The new balance amount for the period.","format":"float","type":"number"},"paymentDueDate":{"description":"The due date of the statement. This date is in the product timezone.","format":"date","type":"string"},"periodId":{"description":"The period identifier.","type":"string"},"reason":{"description":"If this statement was regenerated due to replay, the replay reason supplied by the user.","nullable":true,"type":"string"},"replayId":{"description":"If this statement was regenerated due to replay, the ID of the replay.","nullable":true,"type":"string"},"statementDate":{"description":"The statement date. This date is in the product timezone.","format":"date","type":"string"},"statementLogicVersion":{"default":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement logic version. When a new statement is generated, it will use the current loan type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementLogicVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That version is also stored on each statement object. When/if the statement is regenerated, it will use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementLogicVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the statement object vs. loan type. This guarantees that the system uses the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic as the original statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - first/original statement logic. All loan types created before the release of the version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", would be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a lender is ready, they can ask Peach to upgrade to version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All statements that were generated before the release of version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be marked as version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - second statement logic that was introduced in Q2 2024. This is a deprecated version and should not be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - third statement logic that was introduced in Q4 2024."},"children":[]}]}]}]}],"type":"integer"},"userId":{"description":"If this statement was regenerated due to replay, the ID of the user that initiated the replay.","nullable":true,"type":"string"},"version":{"description":"The version of the statement. When a statement is updated, we don't delete the old version.\nWe create a new version of the statement. The most recent version of the statement is returned.\n","type":"integer"}},"type":"object"}},"components/schemas/schemas-Statement":{"id":"components/schemas/schemas-Statement","kind":"json-schema","title":"schemas-Statement","data":{"allOf":[{"properties":{"createdAt":{"description":"The timestamp (UTC) of when the statement was created.","format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"description":"The timestamp (UTC) of when the statement was deleted.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The statement's unique identifier.","readOnly":true,"type":"string"},"updatedAt":{"description":"The timestamp (UTC) of when the statement was updated. On update, the system will create a new version of the statement.\n","format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/StatementSharedFields"}]}},"components/schemas/RequestStartDate":{"id":"components/schemas/RequestStartDate","kind":"json-schema","title":"RequestStartDate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the promise to pay plan. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided upon promise to pay plan creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will use the created date (i.e. \"today\") as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it must be a date in the future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you should not pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In case both are provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Peach's system creates the schedule based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed, the system will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule Promise to Pay Periods starting after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"date","type":"string"}},"components/schemas/PromiseToPayPlanPost":{"id":"components/schemas/PromiseToPayPlanPost","kind":"json-schema","title":"PromiseToPayPlanPost","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount required to be fulfilled for each period of the promise to pay plan. Peach's system will use the amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided to trigger any required promise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transitions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed to the endpoint, ensure that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are providing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you should not pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In case both are provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]}],"format":"float","minimum":0.01,"type":"number"},"caseId":{"description":"The ID of the case associated with the promise to pay plan.","nullable":true,"type":"string"},"duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of the promise to pay plan as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods. For example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency=weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the promise will be created with 6 weeks duration and will have 6"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"periods all with the same amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed to the endpoint, ensure that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you should not pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In case both are provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]}],"minimum":1,"type":"integer"},"externalId":{"$ref":"#/components/schemas/ExternalId"},"frequency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The agreed payment frequency of the promise. Peach's system will use the desired frequency to create promise to pay period(s) so the lender can monitor progress against promised payment dates and amount paid."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" options create multiple promise to pay periods, according to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creates a promise with a single period and desired duration of X calendar days or a specific date that should be passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed to the endpoint, ensure that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, you should not pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In case both are provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]}],"enum":["weekly","everyTwoWeeks","twiceMonthly","monthly","singleTerm"],"type":"string"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Promise to Pay Plan and corresponding Promise Period Objects will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned for preview without committing the object to database"},"children":[]}]}]}],"type":"boolean"},"schedule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a custom promise to pay schedule with varying amounts or irregular periods, pass a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating the promise to pay plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object or schedule descriptor attributes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDays"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 'duration' and 'amount') can be passed to create a promise to pay plan. In case both are provided in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}],"items":{"properties":{"amount":{"description":"The promised amount.\n","format":"float","minimum":0.01,"type":"number"},"dueDate":{"description":"The due date of the promised amount.\n","format":"date","type":"string"}},"type":"object"},"type":"array"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach's system will send a notice to the borrower about the promise to pay plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendNotice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, the system will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"specificDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific days designate the day(s) that due dates will fall on. The allowed values for specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day(s) depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-7. 1=Monday...7=Sunday."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide two inputs. The first input (required) is an integer in the valid range 1-7. 1=Monday...7=Sunday."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second input is a date that indicates when to start the cycle. If the second input is not passed, the system will default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the first valid start date based on the first input (the day of week passed in). If this date is provided then it can override"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the minimum due date gap specified on the loan type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1, \"2020-09-16\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide two numbers in the valid range 1-31. 1=first day of a month. Use 31 to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicate the last day of a month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1, 15] or [15, 31]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the last day of a month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: [1]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number to indicate duration as a number of calendar days or provide a valid calendar date in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future. For example: [90] or [\"2020-09-16\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specificDays is left null, then the system will calculate due dates according to the paymentFrequency relative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the origination or activation date (or use existing specific days in the case of change due date)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"singleTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specificDays is mandatory."},"children":[]}]}]}],"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"nullable":true,"type":"array"},"startDate":{"$ref":"#/components/schemas/RequestStartDate"}},"type":"object"}},"components/schemas/PromiseToPayPlanCancel":{"id":"components/schemas/PromiseToPayPlanCancel","kind":"json-schema","title":"PromiseToPayPlanCancel","data":{"properties":{"cancellationCaseId":{"description":"The case to associate with this promise to pay plan cancellation.","nullable":true,"type":"string"},"cancellationReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for canceling the promise to pay plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceledByUser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Promise to pay plan was canceled by an agent or borrower."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanChargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was charged off during the promise period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanAccelerated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was accelerated during the promise period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPromisePlanOffered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - another promise plan was offered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - for any other reason requiring cancellation."},"children":[]}]}]}],"enum":["canceledByUser","loanChargedOff","loanAccelerated","otherPromisePlanOffered","other"],"type":"string"},"reasonDetails":{"description":"Additional details about the reason for canceling the promise to pay plan.\n","nullable":true,"type":"string"}},"required":["cancellationReason"],"type":"object"}},"components/schemas/PromoProgramPaging":{"id":"components/schemas/PromoProgramPaging","kind":"json-schema","title":"PromoProgramPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PromoProgramResult"},"type":"array"}},"type":"object"}]}},"components/schemas/PromoProgramPut":{"id":"components/schemas/PromoProgramPut","kind":"json-schema","title":"PromoProgramPut","data":{"allOf":[{"$ref":"#/components/schemas/PromoProgramPutCommon"},{"properties":{"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program status on a specific loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was created but was not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activated yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion has been canceled for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason. The reason provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoCancelReason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was successfully"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exercised."},"children":[]}]}]}],"enum":["pending","active","canceled","exercised"],"type":"string"}},"type":"object"}],"description":"Update a promo program"}},"components/schemas/PurchasesPaging":{"id":"components/schemas/PurchasesPaging","kind":"json-schema","title":"PurchasesPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Purchase"},"type":"array"}},"type":"object"}]}},"components/schemas/ReadOnlyInternalRefundDetails":{"id":"components/schemas/ReadOnlyInternalRefundDetails","kind":"json-schema","title":"ReadOnlyInternalRefundDetails","data":{"allOf":[{"$ref":"#/components/schemas/InternalRefundDetails"},{"properties":{"refundNonDuePrincipalAmount":{"readOnly":true},"refundTransactionAmount":{"readOnly":true},"refundTransactionId":{"readOnly":true}},"type":"object"}]}},"components/schemas/RefundDetailsV2":{"id":"components/schemas/RefundDetailsV2","kind":"json-schema","title":"RefundDetailsV2","data":{"allOf":[{"$ref":"#/components/schemas/ReadOnlyInternalRefundDetails"},{"properties":{"description":{"default":"Refund","description":"The description of the refund. Normally shown in Borrower Portal and/or on statements.","nullable":true,"type":"string"},"merchantId":{"description":"The merchant identifier that the refund was used for.","nullable":true,"type":"string"},"merchantName":{"description":"The merchant name that the refund was used for.","nullable":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"}},"type":"object"}]}},"components/schemas/LoanRefundTimestamps":{"id":"components/schemas/LoanRefundTimestamps","kind":"json-schema","title":"LoanRefundTimestamps","data":{"properties":{"canceledAt":{"format":"date-time","type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"readOnly":true,"type":"object"}},"components/schemas/LoanRefundV2":{"id":"components/schemas/LoanRefundV2","kind":"json-schema","title":"LoanRefundV2","data":{"properties":{"atFaultParty":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The party at fault for the refund. Mainly used for ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOwner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the lender is billed (on accounting level) for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanServicer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the servicer is billed (on accounting level) for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the merchant is billed (on accounting level) for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the merchant is billed (on accounting level) for the refund."},"children":[]}]}]}],"enum":["loanOwner","loanServicer","merchant","borrower"],"type":"string"},"canceledBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for canceling the refund.\nCan be an agent or automated system process.\n"},"cancellationCaseId":{"description":"The cancellation case identifier.","readOnly":true,"type":"string"},"cancellationReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the refund was canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wrongAmountOrDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was created with the wrong amount or details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processingError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund could not be processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - any other reason why the refund was canceled."},"children":[]}]}]}],"enum":["wrongAmountOrDetails","processingError","other"],"readOnly":true,"type":"string"},"cancellationReasonDetails":{"description":"The reason for refund cancellation. This is typically entered by an agent canceling a refund via the front end.","readOnly":true,"type":"string"},"caseId":{"description":"The case identifier.","type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the refund.\nCan be an agent or automated system process.\n"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId=ACBCE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and NOT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating the object."},"children":[]}]}]}],"minLength":1,"nullable":true,"type":"string"},"feesExceptionList":{"default":[],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the dynamic fees (aka LoanFee) identifiers that will not be refunded/canceled. The identifiers can be Peach or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lender's external identifiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows lenders to exclude specific fees from being refunded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundLateFees=true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feesExceptionList=[LF-K98P-NM3E]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will refund/cancel all late fees except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LF-K98P-NM3E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"id":{"readOnly":true,"type":"string"},"isFullRefund":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the refund is a full refund, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the amount is a partial refund."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"isRefundDownPayment":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will refund the down payment amount (assuming the down payment was paid by the borrower)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if refunded for a full amount."},"children":[]}]}]}],"type":"boolean"},"isRefundLateFees":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will cancel any late fees charged after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate + refundTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will not cancel any late fees as part of the refund."},"children":[]}]}]}],"type":"boolean"},"isRefundMDR":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will record the prorated MDR amount to the merchant within the ledger."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach is not involved in the settlement process with merchants, and will only record amounts in the ledger."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the activation date."},"children":[]}]}]}],"type":"boolean"},"isRefundOriginationFees":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will forego origination fee. Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the loan activation date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will not do anything with the origination fee as part of the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: refunding the origination fee is different from calling \"Update origination fee\" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the origination fee is refunded, the system books the origination fees amount and move the entries to \"foregone\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"immediately after."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the origination fee amount is updated via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Update origination fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system changes the origination fee amount,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"re-books the fee from the activation date and replays the loan."},"children":[]}]}]}],"type":"boolean"},"isRefundOtherFees":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will cancel any dynamic fees (except for late fees and fees listed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherFeesExceptionList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charged after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate + refundTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will not cancel any dynamic fees (other than late fees and fees listed in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherFeesExceptionList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as part of the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if an account ends in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status after the refund is applied, any service fees after the payoff date will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be canceled, regardless of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isRefundOtherFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":"boolean"},"originalAmount":{"description":"The original amount of the refund. The amount must be positive.","format":"float","readOnly":true,"type":"number"},"refundAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund amount. The maximum eligible refund amount is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinancedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the loan. The refund is applied against the principal of the loan."},"children":[]}]}]}],"exclusiveMinimum":true,"format":"float","minimum":0,"type":"number"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund effective date in the product timezone. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be any date between the activation date and the current date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, the refund will be recorded in the ledger with an effective timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make the refund effective from the beginning of the loan, please pass the activation date and don't pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, the system will create the refund immediately after the activation."},"children":[]}]}]}],"format":"date","type":"string"},"refundDetails":{"$ref":"#/components/schemas/RefundDetailsV2"},"refundTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"default":{"hour":12,"minute":1,"second":0}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. The default value is 12:01:00 AM in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only, the value must be after 2AM in the product timezone."},"children":[]}]}]}],"writeOnly":true},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRefundProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean","writeOnly":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the refund. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was successfully processed. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund is being processed. Wait until the status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was canceled or not processed."},"children":[]}]}]}],"enum":["settled","processing","canceled"],"nullable":true,"readOnly":true,"type":"string"},"timestamps":{"$ref":"#/components/schemas/LoanRefundTimestamps"}},"required":["refundAmount","atFaultParty"],"type":"object"}},"components/schemas/LoanRefundV2CollectionResponse":{"id":"components/schemas/LoanRefundV2CollectionResponse","kind":"json-schema","title":"LoanRefundV2CollectionResponse","data":{"properties":{"eligibleRefundAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining amount eligible for refund. This is equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinancedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus prior refund amounts."},"children":[]}]}]}],"format":"float","type":"number"},"refunds":{"items":{"$ref":"#/components/schemas/LoanRefundV2"},"type":"array"}},"type":"object"}},"components/schemas/RefundDetails":{"id":"components/schemas/RefundDetails","kind":"json-schema","title":"RefundDetails","data":{"description":"The details of refund.","properties":{"categoryId":{"description":"The category identifier of the refund.","nullable":true,"type":"string"},"description":{"default":"Refund","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the refund. Normally shown in Borrower Portal and on statements. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"nullable":true,"type":"string"},"merchantId":{"description":"The merchant identifier that the refund was used for.","nullable":true,"type":"string"},"merchantName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant name that the refund was used for. At least one of the attributes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"nullable":true,"type":"string"},"metadata":{"description":"Store any type of key/value pairs in the form of a JSON dictionary.","nullable":true,"type":"object"},"pointOfSaleType":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was made online on a website or in a mobile application."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"physical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was made in a store with a physical card or instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the refund was made as part of a subscription service."},"children":[]}]}]}]}],"enum":["online","physical","recurring"],"type":"string"}},"type":"object"}},"components/schemas/LoanRefund":{"id":"components/schemas/LoanRefund","kind":"json-schema","title":"LoanRefund","data":{"properties":{"atFaultParty":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The party at fault for the refund. Mainly used for ledger/accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanOwner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the lender is billed for the entire refund, and paid interest and fees are refunded to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanServicer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the servicer is billed for the entire refund, and paid interest and fees are refunded to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the merchant is billed for the entire refund, and paid interest and fees are refunded to the borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the merchant is billed for the entire refund, and the borrower receives no refund for paid interest and fees."},"children":[]}]}]}],"enum":["loanOwner","loanServicer","merchant","borrower"],"type":"string"},"caseId":{"description":"The case identifier.","type":"string"},"isFullRefund":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the refund is a full refund, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the amount is a partial refund."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"originalAmount":{"description":"The original amount of the refund. The amount must be positive.","format":"float","readOnly":true,"type":"number"},"refundAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund amount. The maximum eligible refund amount is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountFinancedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the loan. The refund is applied against the principal of the loan."},"children":[]}]}]}],"exclusiveMinimum":true,"format":"float","minimum":0,"type":"number"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute can be set only during the migration process of loans from another system to Peach. Any value passed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" loans will be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund effective date in the product timezone. If not provided, the refund will be recorded in the ledger with an effective timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]}]}]}],"format":"date","type":"string"},"refundDetails":{"$ref":"#/components/schemas/RefundDetails"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanRefundProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean","writeOnly":true},"timestamps":{"$ref":"#/components/schemas/LoanRefundTimestamps"}},"required":["refundAmount","atFaultParty"],"type":"object"}},"components/schemas/LoanRefundCancel":{"id":"components/schemas/LoanRefundCancel","kind":"json-schema","title":"LoanRefundCancel","data":{"allOf":[{"properties":{"cancellationReason":{"description":"Reason the refund was canceled.\n","enum":["wrongAmountOrDetails","processingError","other"],"type":"string"},"cancellationReasonDetails":{"description":"The reason for refund cancellation. This is typically entered by an agent canceling a refund via the front end.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"components/schemas/properties-caseId":{"id":"components/schemas/properties-caseId","kind":"json-schema","title":"properties-caseId","data":{"description":"An identifier for an existing case.","type":"string"}},"components/schemas/LoanReimburse":{"id":"components/schemas/LoanReimburse","kind":"json-schema","title":"LoanReimburse","data":{"properties":{"caseId":{"$ref":"#/components/schemas/properties-caseId"},"contactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier of an existing contact. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the check is processed/sent by Peach."},"children":[]}]}]}],"type":"string"},"customDisplayName":{"description":"A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements (or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will render the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n","nullable":true,"type":"string"},"externalTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction external identifier. If passed, the new reimbursement transaction that the system will create will have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the lender assumes responsibility for transferring funds to the borrower. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Peach handles the transfer of funds to the borrower."},"children":[]}]}]}],"type":"boolean"},"paymentInstrumentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's unique or lender's external identifier. Not required if the paymentInstrumentType=check and the check is processed/sent by Peach."},"children":[]}]}]}],"pattern":"^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string"},"paymentInstrumentType":{"enum":["bankAccount","card","check","payroll","paymentNetwork"],"type":"string"},"reimbursementAmount":{"description":"The requested reimbursement amount.","format":"float","type":"number"},"transactionStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if isExternal=true. The status in which the new reimbursement transaction will be created. If the status is set to pending, the caller"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can later update the transaction status via Update transaction endpoint. Only applicable if isExternal=true."},"children":[]}]}]}],"enum":["pending","succeeded"],"type":"string"}},"required":["paymentInstrumentType","reimbursementAmount"],"type":"object"}},"components/schemas/LoanReverseAccelerateResponse":{"id":"components/schemas/LoanReverseAccelerateResponse","kind":"json-schema","title":"LoanReverseAccelerateResponse","data":{"properties":{"reversedAcceleratedAmount":{"description":"The amount of the acceleration reversal.","format":"float","type":"number"}},"type":"object"}},"components/schemas/LoanReverseChargeOffResponse":{"id":"components/schemas/LoanReverseChargeOffResponse","kind":"json-schema","title":"LoanReverseChargeOffResponse","data":{"properties":{"reversedChargeOffAmount":{"description":"The amount of the charge-off reversal.","format":"float","type":"number"}},"type":"object"}},"components/schemas/EveryTwoWeeksOptions":{"id":"components/schemas/EveryTwoWeeksOptions","kind":"json-schema","title":"EveryTwoWeeksOptions","data":{"properties":{"days":{"items":{"properties":{"date":{"format":"date","type":"string"},"day":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"dayOfWeek":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/LoanScheduleOptions":{"id":"components/schemas/LoanScheduleOptions","kind":"json-schema","title":"LoanScheduleOptions","data":{"properties":{"frequencyOptions":{"properties":{"everyTwoWeeks":{"$ref":"#/components/schemas/EveryTwoWeeksOptions"}},"type":"object"}},"type":"object"}},"components/schemas/StatementsPaging":{"id":"components/schemas/StatementsPaging","kind":"json-schema","title":"statements","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/schemas-Statement"},"type":"array"}},"type":"object"}],"title":"statements"}},"components/schemas/StatementActivity":{"id":"components/schemas/StatementActivity","kind":"json-schema","title":"StatementActivity","data":{"properties":{"activityType":{"description":"The activity type.\n","enum":["fee","payment","paymentReversal","credit","creditReversal","refund","reimbursement","purchase"],"type":"string"},"amount":{"description":"The amount of the activity.\n","format":"float","type":"number"},"dateOfActivity":{"description":"The date the activity was posted.\n","format":"date","type":"string"},"description":{"description":"The description of the activity.\n","type":"string"},"effectiveDate":{"description":"The effective date of the activity in the product timezone.\n","format":"date","type":"string"},"referenceNumber":{"description":"The reference number or identifier of the activity.\n","type":"string"}},"type":"object"}},"components/schemas/StatementActivityV2":{"id":"components/schemas/StatementActivityV2","kind":"json-schema","title":"StatementActivityV2","data":{"properties":{"activityType":{"description":"The activity type.\n","enum":["fee","payment","paymentReversal","credit","creditReversal","refund","reimbursement","purchase","advance","purchaseDispute","cashback"],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective amount of the activity that was applied in the ledger in the current or a past"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are expected to be equal unless something happened to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the activity after the activity was originally applied in the ledger."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 1:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment was originally processed for $100.00 from the borrower's bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Later, $30.00 was reversed (the $30.00 was sent back to the borrower's bank account)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $70.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $100.00"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 2:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A service fee of $10.00 was supposed to be charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line (e.g. credit card) had a credit balance of $3.50 (in other words, $3.50 was owed to a borrower)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $6.50."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $10.00."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's important to understand how "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to calculate either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the \"total\" attributes such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPaymentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAdjustment=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to calculate one of the \"total\" attributes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPaymentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalFeesForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAdjustment=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reflected in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the reported activity impacted one of the past periods, the loan was replayed and the balance was adjusted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep in mind that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to sum of activities' "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAdjustmentForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment was originally processed for $100.00 two periods ago."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Later, the payment was disputed by a borrower and the chargeback was accepted for the full amount of $100.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the line accrues interest, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be different from $100.00 because additional interest was accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $0.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $100.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestAdjustmentForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $1.42."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $101.42."},"children":[]}]}]}]}],"format":"float","type":"number"},"dateOfActivity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the activity was created. Also called \"transaction date\". Most activities will have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfActivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfActivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit card purchase was made and authorized on Mar 11, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchase was captured/settled on Mar 13, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateOfActivity is Mar 11, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveDate is Mar 13, 2023."},"children":[]}]}]}]}],"format":"date","type":"string"},"description":{"description":"The description of the activity.\n","type":"string"},"displaySign":{"description":"The sign that should be displayed next to the amount.\n","enum":["positive","negative"],"type":"string"},"drawId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The draw identifier that the activity belongs to. Only applicable to line of credit and the following activity types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the activity was applied in the ledger in the product timezone. Also called \"post date\". Most activities will have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfActivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfActivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit card swipe/purchase was made and authorized on Mar 11, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purchase was captured/settled on Mar 13, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfActivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Mar 11, 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Mar 13, 2023."},"children":[]}]}]}]}],"format":"date","type":"string"},"isAdjustment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the activity was originally applied in the ledger in the current period. In other words, it's not an adjustment of an activity that was already reported in a past period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the activity was reported in the current period but it impacted one of the past periods. In other words, the activity is a change or an adjustment of one of the prior activities that was reported in a past period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an activity with an effective date in one of the past periods is reported, the balance impact is captured in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. Keep in mind that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be different from the activity "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment was originally processed for $100.00 two periods ago. That activity was reported as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAdjustment=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Later, the payment was disputed by a borrower and the chargeback was accepted for the full amount of $100.00. The chargeback activity would be reported as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAdjustment=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the line accrues interest, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be different from $100.00 because additional interest was accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $0.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $100.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountForTotals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be equal to $0.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAdjustmentsForThisPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be greater than $100.00."},"children":[]}]}]}]}],"type":"boolean"},"originalAmount":{"description":"The original amount of the activity that was applied in the ledger before any changes or adjustments.\n","format":"float","type":"number"},"referenceNumber":{"description":"Peach Public ID of the underlying object that created the activity.\n","type":"string"},"referenceNumberExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External ID of the underlying object that created the activity. If the corresponding object doesn't have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attribute value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/BaseStatementDetails":{"id":"components/schemas/BaseStatementDetails","kind":"json-schema","title":"BaseStatementDetails","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/StatementSharedFields"},{"properties":{"autopay":{"description":"The Autopay details at the time of statement generation. Note: Autopay plan can be canceled any time by the borrower, agent (on behalf of the borrower) or system (e.g. bank account closed).\n","properties":{"paymentInstrumentId":{"description":"The payment instrument ID with which this autopay plan will be charged through.","nullable":true,"type":"string"},"schedule":{"items":{"properties":{"amount":{"description":"The amount of the expected payment.","format":"float","type":"number"},"date":{"description":"The due date of the expected payment.","format":"date","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"borrowerDetails":{"description":"The borrower details.\n","properties":{"address":{"$ref":"#/components/schemas/Address"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The borrower name. If the borrower is a person, the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the borrower is a business, the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},"creditBalanceAmount":{"description":"The total amount of money that the lender owes to the borrower.\n","format":"float","type":"number"},"creditBalanceNetChangeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The net change amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reimbursementAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") during the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 1:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the prior period "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=0 and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=100."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the this period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new purchase or advance was made in amount of $35"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decreased by 35)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceNetChangeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=-35."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example 2:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the prior period "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=0 and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=100."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the this period:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A check in amount of $20 was posted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" increased by 20)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new purchase or advance was made in amount of $35"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decreased by 35)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceNetChangeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=+20-35=-15."},"children":[]}]}]}]}],"format":"float","type":"number"},"daysInBillingCycle":{"description":"The number of calendar days in the billing cycle (also called period).\n","type":"integer"},"fulfilledAmount":{"description":"The total amount of payments and service credits applied towards minimumAmountDue.","format":"float","type":"number"},"interestAdjustmentForThisPeriod":{"description":"In some cases account balances can be adjusted because some event changed in the past. For example: late\nreturn of a payment which results in additional interest charged for a period in the past. When such\nadjustments are made this attribute reflects the net adjusted interest amount. The interest adjustment can\nbe positive or negative.\n","format":"float","nullable":true,"type":"number"},"isDisplayLatePaymentWarning":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the statement should show a special warning amount late fees - \"Late Payment Warning\" paragraph."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product type doesn't have any late fees the system will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"lastPeriodFeesPaid":{"description":"Fees amount paid (by the borrower or via credit) in the statement corresponding period.\n","format":"float","type":"number"},"lastPeriodInterestPaid":{"description":"Interest amount paid (by the borrower or via credit) in the statement corresponding period.\n","format":"float","type":"number"},"lastPeriodOverPaid":{"description":"Excess amount paid (by the borrower or via credit) that was not allocated to principal,\ninterest or fees in the statement corresponding period.\n","format":"float","type":"number"},"lastPeriodPrincipalPaid":{"description":"Principal amount paid (by the borrower or via credit) in the statement corresponding period.\n","format":"float","type":"number"},"lastPeriodTotalPaid":{"description":"Total amount paid (by the borrower or via credit) in the statement corresponding period.\n","format":"float","type":"number"},"lateFeeUpToAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of late fee that can be charged in the period (if the borrower doesn't pay on time). The attribute will have value if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDisplayLatePaymentWarning"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"loanStatus":{"allOf":[{"$ref":"#/components/schemas/LoanStatus"},{"readOnly":true}]},"newPrincipalBalance":{"description":"Principal balance of the account as of the statement date and corresponding period.\n","format":"float","type":"number"},"overdueAmount":{"description":"Overdue amount as of the statement date and corresponding period.\n","format":"float","type":"number"},"overpaymentsAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case that loan policy allows, this represents the amount of overpayments applied to the period. Overpayments will only arise when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an obligation (aka "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimumAmountDue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is completely fulfilled."},"children":[]}]}]}],"format":"float","type":"number"},"previousBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous statement balance (also called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"float","type":"number"},"previousCreditBalanceAmount":{"description":"The total amount of money that the lender owed to the borrower in the previous statement.\n","format":"float","type":"number"},"promoPrograms":{"items":{"properties":{"description":{"description":"A legal description of the promotional program as it\nshould be communicated and shown to borrowers.\nIf the description is provided, borrowers will see\nthe description in the Borrower Portal.\n","type":"string"},"displayName":{"description":"The promotional program name as it is shown to\nborrowers.\n","type":"string"},"drawId":{"type":"string"},"externalId":{"type":"string"},"id":{"type":"string"},"promoCancelReason":{"$ref":"#/components/schemas/PromoCancelReason"},"promoEndDate":{"$ref":"#/components/schemas/PromoStartDate"},"promoExercisedDate":{"format":"date","type":"string"},"promoStartDate":{"$ref":"#/components/schemas/PromoStartDate"},"promoType":{"$ref":"#/components/schemas/PromoType"},"remainingAmountToExercise":{"description":"Represents the remaining balance needed to be paid in\norder to exercise the promotional program.\n","type":"number"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promotional program status on a specific loan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was created but was not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activated yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion has been canceled for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoCancelReason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exercised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the promotion was successfully"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exercised."},"children":[]}]}]}],"enum":["pending","active","canceled","exercised"],"type":"string"},"totalDeferredInterestAmount":{"description":"The total deferred interest accrued.\nIf the deferred interest promotion is exercised, the\ndeferred interest is not expected to be paid.\nOnly for deferred interest promo programs.\n","type":"number"}},"required":["id","status","promoType"],"type":"object"},"type":"array"},"remainingAmount":{"description":"The total amount remaining to be paid by the borrower after accounting for payments and service credits applied in the period.","format":"float","type":"number"},"statementActivities":{"items":{"oneOf":[{"$ref":"#/components/schemas/StatementActivity"},{"$ref":"#/components/schemas/StatementActivityV2"}]},"type":"array"},"statementLogicVersion":{"default":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement logic version. When a new statement is generated, it will use the current loan type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementLogicVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That version is also stored on each statement object. When/if the statement is regenerated, it will use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementLogicVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the statement object vs. loan type. This guarantees that the system uses the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logic as the original statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - first/original statement logic. All loan types created before the release of the version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", would be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a lender is ready, they can ask Peach to upgrade to version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All statements that were generated before the release of version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be marked as version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - second statement logic that was introduced in Q2 2024. This is a deprecated version and should not be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - third statement logic that was introduced in Q4 2024."},"children":[]}]}]}]}],"type":"integer"},"totalAdjustmentsForThisPeriod":{"description":"In some cases account balances can be adjusted because some event changed in the past.\nFor example: late return of a payment or interest changed for a period in the past.\nWhen such adjustments are made this attribute reflects the net adjusted amount.\n","format":"float","type":"number"},"totalCreditReversalsForThisPeriod":{"description":"Total of credits reversed/canceled in the period.\n","format":"float","type":"number"},"totalCreditsForThisPeriod":{"description":"Total of credits applied in the period.\n","format":"float","type":"number"},"totalFeesForThisPeriod":{"description":"Total amount of fees charged in the period.\n","format":"float","type":"number"},"totalInterestForThisPeriod":{"description":"For LOC:\n  Total amount of interest accrued on draws in the period. The interest amount accrued on each draw is truncated to the nearest cent and\n  the sum of the truncated values is reported by this field.\nFor installment loan:\n  If the period is still open, the amount will be accrued interest in the period plus expected interest to be accrued until the due date.\n","format":"float","type":"number"},"totalPaymentReversalsForThisPeriod":{"description":"Total of payments reversed/returned to the borrower in the period.\n","format":"float","type":"number"},"totalPaymentsForThisPeriod":{"description":"Total of payments made in the period.\n","format":"float","type":"number"},"totalRefundsForThisPeriod":{"description":"Total of refunds applied in the period.\n","format":"float","type":"number"},"year":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The year of the statement. Year-to-date fields are calculated based on this value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usually the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the statement period is the reference for the year. The exception is when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementDate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is before the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the reference for the year."},"children":[]}]}]}],"type":"string"},"yearToDateFeesCharged":{"description":"Total amount of fees charged in the current year from 01/01/YYYY to the statement date.\n","format":"float","type":"number"},"yearToDateInterestCharged":{"description":"Total amount of interest charged in the current year from 01/01/YYYY to the statement date. This field is computed as the sum\nof the interest accrued by the draws on this line and then rounded to the nearest cent.\n","format":"float","type":"number"},"ytdFeesPaid":{"description":"Fees amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n","format":"float","type":"number"},"ytdInterestPaid":{"description":"Interest amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n","format":"float","type":"number"},"ytdOverPaid":{"description":"Excess amount paid (by the borrower or via credit) that was not allocated to principal,\ninterest or fees year to date, from 01/01/YYYY to the statement date.\n","format":"float","type":"number"},"ytdPrincipalPaid":{"description":"Principal amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n","format":"float","type":"number"},"ytdTotalPaid":{"description":"Total amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n","format":"float","type":"number"}},"type":"object"}]}},"components/schemas/InstallmentStatementDetails":{"id":"components/schemas/InstallmentStatementDetails","kind":"json-schema","title":"Installment","data":{"allOf":[{"$ref":"#/components/schemas/BaseStatementDetails"},{"properties":{"apr":{"description":"The effective APR.","format":"float","type":"number"},"prepaidAmount":{"description":"Amount paid in the period prior to due date.\n","format":"float","type":"number"},"recurringAmount":{"description":"The most recent amortized recurring amount.\n","format":"float","type":"number"},"totalAdvancesForThisPeriod":{"description":"The total amount of advances made in the period.\n","format":"float","nullable":true,"type":"number"},"totalAmountDue":{"description":"The total amount due for the period as of the time when the statement was generated. It represents the sum\nof the minimumAmountDue and overdueAmount minus any payments or service credits applied in the period.\n","format":"float","type":"number"}},"title":"Installment","type":"object"}],"title":"Installment"}},"components/schemas/StatementDrawInfo":{"id":"components/schemas/StatementDrawInfo","kind":"json-schema","title":"StatementDrawInfo","data":{"properties":{"apr":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The net interest rate (also called APR), interest rate minus promo rate, of the draw/sub-line as of the last day of the period (aka "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingCycleEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"float","type":"number"},"availableCredit":{"description":"Available credit for this specific draw.","format":"float","type":"number"},"balanceEndOfPeriod":{"description":"The draw/sub-line remaining balance at the end of the period.\n","format":"float","type":"number"},"creditLimit":{"description":"The credit limit amount for the draw.","format":"float","type":"number"},"deferredInterestForThisPeriod":{"description":"The deferred interest accrued for this period only.\nIf the deferred interest promotion is exercised, the deferred interest\nis not expected to be paid.\n","format":"float","type":"number"},"drawId":{"description":"The draw identifier.","type":"string"},"fulfilledAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of payments and service credits applied towards `minAmountDue``."},"children":[]}]}]}],"format":"float","type":"number"},"interestCharged":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of interest accrued in the period. This value is computed by truncating (to the nearest cent) the interest accrued in this period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is amount is equal to the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestChargedDetails.interestCharged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" amounts in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestChargedDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"format":"float","type":"number"},"interestChargedDetails":{"description":"Details of interest charged in the period.","items":{"properties":{"balanceSubjectToInterestRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The average balance of draw/sub-line that was subject to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated by adding the principal amount on days with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"divided by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Also called Average Daily Balance."},"children":[]}]}]}],"format":"float","type":"number"},"interestChargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of interest charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daily"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a standard daily accrual in the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - deferred interest that was recognized/charged in the period. Note: the interest amount that was charged in the period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is a total of deferred interest that was accrued across multiple periods."},"children":[]}]}]}]}],"enum":["daily","deferred"],"type":"string"},"interestCharged":{"description":"The net interest rate (also called APR). Calculated as interest rate minus promo rate of the draw/sub-line as of the last day of the period (aka the billingCycleEndDate).\n","format":"float","type":"number"},"interestRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The net interest rate that the balance accrued interest for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the draw has a single interest rate, the value is also called"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APR of the draw/sub-line. If the draw was created in the middle of the period or was paid off before the period ended, the system will count"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"numberDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of days in the period that principal was subject to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the array is equal to the number of days in the period."},"children":[]}]}]}],"type":"integer"}},"type":"object"},"type":"array"},"isVariableRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the rate is variable. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the rate is fixed."},"children":[]}]}]}],"type":"boolean"},"minAmountDue":{"description":"The minimum amount due of the draw/sub-line for the period.\n","format":"float","type":"number"},"nameOfBalance":{"description":"The name of the balance (also called draw/sub-line).\n","type":"string"},"overLimitAmount":{"description":"The amount by which the balance exceeded the credit limit for the draw. This amount is expected to be greater than 0 \nonly when the credit limit is exceeded.\n","format":"float","type":"number"},"overpaymentsAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case that loan policy allows, this represents the amount of overpayments applied to the period. Overpayments will only arise when an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"obligation (aka "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmountDue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is completely fulfilled."},"children":[]}]}]}],"format":"float","type":"number"},"remainingAmount":{"description":"The total amount remaining to be paid by the borrower after accounting for payments and service credits applied in the period.","format":"float","type":"number"},"totalDeferredInterestAmount":{"description":"The total deferred interest accrued.\nIf the deferred interest promotion is exercised, the deferred interest\nis not expected to be paid. Only for deferred interest promo programs.\n","format":"float","type":"number"},"totalPurchasesForThisPeriod":{"description":"Total of new purchases on the draw in the period corresponding to the statement.\n","format":"float","type":"number"},"utilizationAmount":{"$ref":"#/components/schemas/UtilizationAmount"}},"type":"object"}},"components/schemas/LOCStatementDetails":{"id":"components/schemas/LOCStatementDetails","kind":"json-schema","title":"Line of Credit","data":{"allOf":[{"$ref":"#/components/schemas/BaseStatementDetails"},{"properties":{"authorizedPurchasesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of authorized purchases at the time of statement generation. This amount reduces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableCredit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openToBuy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; is not included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; and appears in the Account Summary section of the statement."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"availableCredit":{"description":"Available credit to use.\n","format":"float","type":"number"},"creditLimit":{"description":"The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n","format":"float","type":"number"},"isDisplayMinimumPaymentWarning":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the statement should show a special warning amount minimum payment - \"Minimum Payment Warning\" paragraph and table."},"children":[]}]}]}],"type":"boolean"},"locClosedDate":{"description":"The date LOC was closed in the product timezone. If LOC is closed, new purchases are not allowed. Closed LOC can still have outstanding balance.\n","format":"date","type":"string"},"minimumPaymentWarning":{"description":"The details required to show the Minimum Payment Warning table in the statement.","properties":{"comparedToDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of years it should take to pay off the balance if the borrower pays the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comparedToPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per regulations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the estimate must be disclosed in years and rounded to the nearest whole year."},"children":[]}]}]}],"type":"integer"},"comparedToDurationMonths":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months it should take to pay off the balance if the borrower pays the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comparedToPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per regulations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the estimate must be disclosed in years and rounded to the nearest whole year."},"children":[]}]}]}],"type":"integer"},"comparedToPaymentAmount":{"description":"The payment amount that the minimum amount is compared to.\n","format":"float","type":"number"},"comparedToTotalCostAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated total amount (or cost) the borrower is expected to pay if the borrower pays the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comparedToPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"format":"float","type":"number"},"minimumPaymentDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of years it should take to pay off the balance if the borrower makes the minimum payment only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per regulations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the estimate must be disclosed in years and rounded to the nearest whole year."},"children":[]}]}]}],"type":"integer"},"minimumPaymentDurationMonths":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months it should take to pay off the balance if the borrower makes the minimum payment only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per regulations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the estimate must be disclosed in years and rounded to the nearest whole year."},"children":[]}]}]}],"type":"integer"},"minimumPaymentTotalCostAmount":{"description":"The estimated total amount (or cost) the borrower is expected to pay if the borrower makes the minimum payment only.\n","format":"float","type":"number"}},"type":"object"},"statementDrawInfo":{"items":{"$ref":"#/components/schemas/StatementDrawInfo"},"type":"array"},"totalCashBacksForThisPeriod":{"description":"Total of cashBacks applied in the period.\n","format":"float","type":"number"},"totalPurchasesForThisPeriod":{"description":"Total of new purchases in the period corresponding to the statement.\n","format":"float","type":"number"},"utilizationAmount":{"$ref":"#/components/schemas/UtilizationAmount"}},"title":"Line of Credit","type":"object"}],"title":"Line of Credit"}},"components/schemas/StatementDetails":{"id":"components/schemas/StatementDetails","kind":"json-schema","title":"StatementDetails","data":{"oneOf":[{"$ref":"#/components/schemas/InstallmentStatementDetails"},{"$ref":"#/components/schemas/LOCStatementDetails"}]}},"components/schemas/TransactionsPaging":{"id":"components/schemas/TransactionsPaging","kind":"json-schema","title":"transactions","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"}},"type":"object"}],"title":"transactions"}},"components/schemas/TransactionCreationStatus":{"id":"components/schemas/TransactionCreationStatus","kind":"json-schema","title":"TransactionCreationStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction status. May only be passed when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External transactions can be created in: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External transactions are applied to the loan balance immediately when created with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they will be applied the first time they are updated to one of these statuses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was scheduled for a future date that has not arrived yet. The payment has not applied to a loan yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment failed and was removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status effective date. The system replays the loan as if the payment never happened."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will also re-accrue interest since then. Disputed payment can be for partial amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment or credit was canceled. Payment can be canceled only if the current status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount."},"children":[]}]}]}],"enum":["scheduled","initiated","pending","succeeded","failed","canceled","inDispute","chargeback"],"type":"string"}},"components/schemas/OneTimePaymentTransaction":{"id":"components/schemas/OneTimePaymentTransaction","kind":"json-schema","title":"One Time Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseOneTimePaymentTransaction"},{"properties":{"consentDocumentId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID of a one-time payment consent given by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower to debit their payment instrument.  The document is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored in the HTML format and contains the disclosure shown to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the borrower at the time of the payment.  Required if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Peach is processing payments (aka"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on behalf of the lender."},"children":[]}]}]}]}]},"drawId":{"description":"The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the transaction in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For active loans (non-migrating), to create and backdate the transaction in one call:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (today or in the past)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leave "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The call triggers replay; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to wait for completion (408 on timeout)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeededAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will equal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appliedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pendingAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will equal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction will appear on the next day's loan tape (relative to the API call date in the product timezone)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For migrating loans ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the attribute is used during migration ingest only."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For active loans with external payments, required together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-call backdating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value must be after 2AM in the product timezone."},"children":[]}]}]}],"type":"object","writeOnly":true}]},"enablePrepayments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply any overpayment amount to prepayment of future obligations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply overpayments to the current obligation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not passed, we reference the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPrepayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration on the loan type."},"children":[]}]}]}],"type":"boolean"},"holdDaysEndDate":{"$ref":"#/components/schemas/HoldDaysEndDate"},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for record purposes only. A transaction with an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically marked external."},"children":[]}]}]}],"type":"boolean"},"scheduledDate":{"description":"This attribute should be used only for transactions that are scheduled in the future. Transactions that should be processed now/today,\nleave the attribute empty and the system will set appropriate date and timestamp values based on the API call time.\n\nNote: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today.\n","format":"date","type":"string"},"status":{"$ref":"#/components/schemas/TransactionCreationStatus"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["paymentInstrumentId","amount","type"],"title":"One Time Payment"}},"components/schemas/ServiceCreditTransaction":{"id":"components/schemas/ServiceCreditTransaction","kind":"json-schema","title":"Service Credit","data":{"allOf":[{"$ref":"#/components/schemas/BaseServiceCreditTransaction"},{"properties":{"drawId":{"description":"The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the service credit in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On active (non-migrating) loans, use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"backdate in one call (date must be today or in the past). Triggers replay; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to wait for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completion (408 on timeout). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required when this field is passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On migrating loans ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), used during migration ingest only."},"children":[]}]}]}],"format":"date","type":"string","writeOnly":true},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For active loans, required together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-call backdating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value must be after 2AM in the product timezone."},"children":[]}]}]}],"type":"object","writeOnly":true}]},"enablePrepayments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply any overpayment amount to prepayment of future obligations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the borrower opts to apply overpayments to the current obligation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not passed, we reference the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPrepayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration on the loan type."},"children":[]}]}]}],"type":"boolean"},"scheduledDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This attribute should be used only for transactions that need to be applied now/today or are scheduled in the future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions that should be processed now/today, leave the attribute empty and the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will set appropriate date and timestamp values based on the API call time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a future date is provided, the service credit will be scheduled for the future date and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"won't be applied to the ledger until then."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To apply a service credit with an effective date in the past on an active loan, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (single-call backdate; triggers replay)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["serviceCreditType","serviceCreditSponsor","amount","type"],"title":"Service Credit"}},"components/schemas/serviceCreditTypesForCreate":{"id":"components/schemas/serviceCreditTypesForCreate","kind":"json-schema","title":"serviceCreditTypesForCreate","data":{"enum":["serviceAgent","serviceSupervisor","settlementOfDebt","settlementOfDebtNoLoss","balanceTransfer","rewards","fraud","badDebt","bankruptcy","deceased","usuryCap"],"type":"string"}},"components/schemas/ServiceCreditTransactionForCreate":{"id":"components/schemas/ServiceCreditTransactionForCreate","kind":"json-schema","title":"Service Credit","data":{"allOf":[{"$ref":"#/components/schemas/ServiceCreditTransaction"},{"properties":{"serviceCreditType":{"$ref":"#/components/schemas/serviceCreditTypesForCreate"}},"type":"object"}],"title":"Service Credit"}},"components/schemas/DownPaymentTransaction":{"id":"components/schemas/DownPaymentTransaction","kind":"json-schema","title":"Down Payment","data":{"allOf":[{"$ref":"#/components/schemas/BaseDownPaymentTransaction"},{"properties":{"consentDocumentId":{"allOf":[{"$ref":"#/components/schemas/AnyId"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document ID of a one-time payment consent given by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"borrower to debit their payment instrument.  The document is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored in the HTML format and contains the disclosure shown to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the borrower at the time of the payment.  Required if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Peach is processing payments (aka"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") on behalf of the lender."},"children":[]}]}]}]}]},"drawId":{"description":"The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective date of the transaction in the product timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On active (non-migrating) loans, use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"backdate in one call ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; date must be today or in the past)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggers replay; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to wait for completion (408 on timeout). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this field is passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On migrating loans ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), used during migration ingest only."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product timezone. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For active loans with external payments, required together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-call backdating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: for migration only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepMigration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value must be after 2AM in the product timezone."},"children":[]}]}]}],"type":"object","writeOnly":true}]},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for record purposes only. A transaction with an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically marked external."},"children":[]}]}]}],"type":"boolean"},"scheduledDate":{"description":"If provided must be a date in the future.\n\nNote: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today.\n","format":"date","type":"string"},"status":{"$ref":"#/components/schemas/TransactionCreationStatus"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}],"required":["paymentInstrumentId","amount","type"],"title":"Down Payment"}},"components/schemas/CreateTransaction":{"id":"components/schemas/CreateTransaction","kind":"json-schema","title":"CreateTransaction","data":{"oneOf":[{"$ref":"#/components/schemas/OneTimePaymentTransaction"},{"$ref":"#/components/schemas/ServiceCreditTransactionForCreate"},{"$ref":"#/components/schemas/DownPaymentTransaction"}],"required":["type"]}},"components/schemas/TransactionUpdate":{"id":"components/schemas/TransactionUpdate","kind":"json-schema","title":"TransactionUpdate","data":{"allOf":[{"$ref":"#/components/schemas/NormalTransaction"},{"properties":{"currency":{"readOnly":true},"isExternal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Updating this field does not modify the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for record purposes only. A transaction with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically marked external."},"children":[]}]}]}]},"isVirtual":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Updating this field does not modify the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isVirtual=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a real transaction, but represents a part of another transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to store the principal/interest split on draws in Line of Credits as well as splits between multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installment loans that were applied as a single payment."},"children":[]}]}]}]},"paidFeesAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Support for this field will be removed in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paid amount allocated to fees"},"children":[]}]}]}]},"paidInterestAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Support for this field will be removed in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paid amount allocated to interest"},"children":[]}]}]}]},"paidOverAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Support for this field will be removed in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stores any excess amount that was not allocated to principal, interest or fees."},"children":[]}]}]}]},"paidPrincipalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Support for this field will be removed in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paid amount allocated to principal"},"children":[]}]}]}]},"paymentDetails":{"readOnly":true},"processorId":{"readOnly":true},"serviceCreditDetails":{"readOnly":true},"transactionType":{"readOnly":true}},"type":"object"}]}},"components/schemas/TransactionUpdateExternal":{"id":"components/schemas/TransactionUpdateExternal","kind":"json-schema","title":"TransactionUpdateExternal","data":{"allOf":[{"$ref":"#/components/schemas/TransactionUpdate"},{"properties":{"timestamps":{"properties":{"effectiveDate":{"readOnly":true}},"type":"object"}},"type":"object"}]}},"components/schemas/LoanUnfreeze":{"id":"components/schemas/LoanUnfreeze","kind":"json-schema","title":"LoanUnfreeze","data":{"allOf":[{"properties":{"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the loan doesn't change and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"retroactivelyAccrueInterest":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accrue interest (as usual) for periods occurring when the loan was frozen. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"periodic payments occurring during the frozen period interest-free."},"children":[]}]}]}],"type":"boolean"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanUnfreeze"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"},"shiftDueDates":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to defer the periodic payment amounts associated with periods that fall in the frozen period to one or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"more new periods generated at the end of a loan. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep the amounts in unfrozen periods."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"components/schemas/fullAccountNumber":{"id":"components/schemas/fullAccountNumber","kind":"json-schema","title":"fullAccountNumber","data":{"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full account number. Only provided if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"showFullAccountNumber=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to get the full number."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PaymentCardImmutableFields":{"id":"components/schemas/PaymentCardImmutableFields","kind":"json-schema","title":"PaymentCardImmutableFields","data":{"properties":{"cardNumberLastFour":{"description":"The last two, three or four digits of the card number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","example":"1111","readOnly":true},"cardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of card."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For external payment instruments, this field is required, and does not require additional permissions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, this field is not required, and using it requires permission "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"enum":["credit","debit"],"type":"string"},"cvv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The CVV, typically found on the back of the card."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach does not save CVV and is only used to authenticate the card. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"321","type":"string","writeOnly":true},"instrumentType":{"enum":["card"],"type":"string"},"issuer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuing bank. Requires permission "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"network":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card network. Requires permission "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["visa","mastercard","discover","americanExpress"],"type":"string"}},"type":"object"}},"components/schemas/PaymentCardMutableFields":{"id":"components/schemas/PaymentCardMutableFields","kind":"json-schema","title":"PaymentCardMutableFields","data":{"properties":{"address":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing address associated with the card. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postalCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"$ref":"#/components/schemas/AddressBase"}]},"expirationMonth":{"description":"The expiration month of the card.","example":12,"type":"integer"},"expirationYear":{"description":"The expiration year of the card.","example":2032,"type":"integer"},"firstName":{"description":"First name on the card.","type":"string"},"lastName":{"description":"Last name on the card.","type":"string"}},"type":"object"}},"components/schemas/PaymentCard":{"id":"components/schemas/PaymentCard","kind":"json-schema","title":"Card","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentFailureReasons"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"$ref":"#/components/schemas/PaymentCardImmutableFields"},{"$ref":"#/components/schemas/PaymentCardMutableFields"}],"required":["instrumentType","cardNumber","expirationYear","expirationMonth","firstName","lastName"],"title":"Card"}},"components/schemas/fullCardNumber":{"id":"components/schemas/fullCardNumber","kind":"json-schema","title":"fullCardNumber","data":{"properties":{"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full card number. Also called PAN. Only provided if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"showFullAccountNumber=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.instrument:read.sensitive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to get the full number."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PaymentCheckMutable":{"id":"components/schemas/PaymentCheckMutable","kind":"json-schema","title":"Check","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"accountHolderName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts, the full name of the account holder. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts, the business name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not an account nickname. It should match the name on file for the account with the bank."},"children":[]}]}]}]}],"type":"string"},"accountHolderType":{"description":"Type of entity that is the account holder.","enum":["business","personal"],"type":"string"},"address":{"$ref":"#/components/schemas/AddressBase","description":"The address on the check. Typically located in the top left corner, under the account holder name(s).\n"},"payToTheOrderOfName":{"description":"The name of a person or organization designated to receive the funds,\nsuch as \"John Smith\" or \"Peach Finance, Inc\". Defaults to \"Cash\",\nused when you don't know the person or organization's exact name.\n","type":"string"}},"type":"object"}],"title":"Check"}},"components/schemas/PaymentCheck":{"id":"components/schemas/PaymentCheck","kind":"json-schema","title":"Check","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentFailureReasons"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"accountNumberLastFour":{"description":"The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n","pattern":"^[0-9]{2,4}","readOnly":true,"type":"string"},"checkNumber":{"description":"The check sequence number. Typically located in the top right corner of the check.","type":"string"},"institutionName":{"description":"The name of the bank where this account resides.","readOnly":true,"type":"string"},"instrumentType":{"enum":["check"],"type":"string"},"routingNumber":{"description":"The routing number.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentCheckMutable"}],"required":["accountHolderName","accountHolderType","accountNumber","checkNumber","instrumentType","routingNumber"],"title":"Check"}},"components/schemas/Payroll":{"id":"components/schemas/Payroll","kind":"json-schema","title":"Payroll","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"departmentName":{"description":"The department name.","example":"Accounting","type":"string"},"employeeId":{"description":"The employee/borrower ID in the payroll system.","type":"string"},"employerName":{"description":"The employer name.","type":"string"},"instrumentType":{"enum":["payroll"],"type":"string"},"isExternal":{"enum":[true],"readOnly":true,"type":"boolean"},"payFrequency":{"description":"The payment frequency.","enum":["weekly","everyTwoWeeks","twiceMonthly","monthly"],"example":"everyTwoWeeks","type":"string"},"paySpecificDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific days on which paychecks are made. The allowed values for specific day(s) depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-7. 1=Monday...7=Sunday."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyTwoWeeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-14."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First week: 1=Monday...7=Sunday."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second week: 8=Monday...14=Sunday."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twiceMonthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide two numbers in the valid range 1-31. 1=first day of a month. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the last day of a month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1, 15]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[15, 31]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide one number in the valid range 1-31. 1=first day of a month. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the last day of a month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":[1,15],"items":{"type":"integer"},"type":"array"},"paycheckNetAmount":{"description":"The amount of paycheck after taxes that is deposited to the borrower's bank account.","example":1024,"type":"number"}},"type":"object"}],"title":"Payroll"}},"components/schemas/PaymentNetwork":{"id":"components/schemas/PaymentNetwork","kind":"json-schema","title":"Payment Network","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"instrumentType":{"enum":["paymentNetwork"],"type":"string"},"isExternal":{"enum":[true],"readOnly":true,"type":"boolean"},"paymentNetworkMemberId":{"description":"The borrower identifier in the payment network system.","type":"string"},"paymentNetworkName":{"description":"The payment network name.","type":"string"}},"type":"object"}],"title":"Payment Network"}},"components/schemas/MoneyOrder":{"id":"components/schemas/MoneyOrder","kind":"json-schema","title":"Money Order","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"institutionName":{"description":"The name of the bank where this account resides.","maxLength":36,"type":"string"},"instrumentType":{"enum":["moneyOrder"],"type":"string"},"isExternal":{"enum":[true],"readOnly":true,"type":"boolean"},"routingNumber":{"description":"The routing number.","pattern":"\\d{9}","type":"string"},"serialNumber":{"description":"The money order serial number.","type":"string"}},"type":"object"}],"required":["instrumentType","serialNumber"],"title":"Money Order"}},"components/schemas/Wire":{"id":"components/schemas/Wire","kind":"json-schema","title":"Wire","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentImmutableFields"},{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"properties":{"institutionName":{"description":"The name of the bank where this account resides.","maxLength":36,"type":"string"},"instrumentType":{"enum":["wire"],"type":"string"},"isExternal":{"enum":[true],"readOnly":true,"type":"boolean"},"routingNumber":{"description":"The routing number from where the wire was sent.","pattern":"\\d{9}","type":"string"},"wireNumber":{"description":"The wire number. Must be unique.","type":"string"},"wireType":{"default":"domestic","enum":["domestic","international"],"type":"string"}},"type":"object"}],"required":["instrumentType","wireType","wireNumber"],"title":"Wire"}},"components/schemas/PaymentInstrumentGet":{"id":"components/schemas/PaymentInstrumentGet","kind":"json-schema","title":"PaymentInstrumentGet","data":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/fullAccountNumber"}]},{"allOf":[{"$ref":"#/components/schemas/PaymentCard"},{"$ref":"#/components/schemas/fullCardNumber"}]},{"allOf":[{"$ref":"#/components/schemas/PaymentCheck"},{"$ref":"#/components/schemas/fullAccountNumber"}]},{"allOf":[{"required":["instrumentType","employerName"],"type":"object"},{"$ref":"#/components/schemas/Payroll"}],"title":"Payroll"},{"allOf":[{"required":["instrumentType","paymentNetworkName"],"type":"object"},{"$ref":"#/components/schemas/PaymentNetwork"}],"title":"Payment Network"},{"allOf":[{"$ref":"#/components/schemas/MoneyOrder"},{"$ref":"#/components/schemas/fullAccountNumber"}]},{"allOf":[{"$ref":"#/components/schemas/Wire"},{"$ref":"#/components/schemas/fullAccountNumber"}]}]}},"components/schemas/hideFailureReason":{"id":"components/schemas/hideFailureReason","kind":"json-schema","title":"hideFailureReason","data":{"properties":{"failureReason":{"readOnly":true}},"type":"object"}},"components/schemas/SendNoticePaymentMethodAdded":{"id":"components/schemas/SendNoticePaymentMethodAdded","kind":"json-schema","title":"SendNoticePaymentMethodAdded","data":{"properties":{"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodAdded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PaymentInstrumentPostBankAccount":{"id":"components/schemas/PaymentInstrumentPostBankAccount","kind":"json-schema","title":"Bank Account","data":{"allOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/bankAccountAccountNumber"},{"$ref":"#/components/schemas/hideFailureReason"},{"$ref":"#/components/schemas/SendNoticePaymentMethodAdded"}],"title":"Bank Account"}},"components/schemas/paymentCardCardNumber":{"id":"components/schemas/paymentCardCardNumber","kind":"json-schema","title":"paymentCardCardNumber","data":{"properties":{"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then only the last two, three, or four digits of the card number can be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide four digits if available, otherwise provide two or three digits."},"children":[]}]}]}],"example":"4111111111111111","type":"string","writeOnly":true}},"required":["cardNumber"],"type":"object"}},"components/schemas/PaymentInstrumentPostCard":{"id":"components/schemas/PaymentInstrumentPostCard","kind":"json-schema","title":"Payment Card","data":{"allOf":[{"$ref":"#/components/schemas/PaymentCard"},{"$ref":"#/components/schemas/paymentCardCardNumber"},{"$ref":"#/components/schemas/hideFailureReason"},{"$ref":"#/components/schemas/SendNoticePaymentMethodAdded"}],"title":"Payment Card"}},"components/schemas/paymentCheckAccountNumber":{"id":"components/schemas/paymentCheckAccountNumber","kind":"json-schema","title":"paymentCheckAccountNumber","data":{"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the last two, three, or four digits of the account number can be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide four digits if available, otherwise provide two or three digits."},"children":[]}]}]}],"pattern":"^[0-9]+$","type":"string","writeOnly":true}},"required":["accountNumber"],"type":"object"}},"components/schemas/PaymentInstrumentPostCheck":{"id":"components/schemas/PaymentInstrumentPostCheck","kind":"json-schema","title":"Check","data":{"allOf":[{"$ref":"#/components/schemas/PaymentCheck"},{"$ref":"#/components/schemas/paymentCheckAccountNumber"},{"$ref":"#/components/schemas/hideFailureReason"}],"title":"Check"}},"components/schemas/moneyOrderAccountNumber":{"id":"components/schemas/moneyOrderAccountNumber","kind":"json-schema","title":"moneyOrderAccountNumber","data":{"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the last two, three, or four digits of the account number can be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide four digits if available, otherwise provide two or three digits."},"children":[]}]}]}],"pattern":"^[0-9]+$","type":"string","writeOnly":true}},"type":"object"}},"components/schemas/PaymentInstrumentPostMoneyOrder":{"id":"components/schemas/PaymentInstrumentPostMoneyOrder","kind":"json-schema","title":"Money Order","data":{"allOf":[{"$ref":"#/components/schemas/MoneyOrder"},{"$ref":"#/components/schemas/moneyOrderAccountNumber"},{"$ref":"#/components/schemas/hideFailureReason"}],"title":"Money Order"}},"components/schemas/PaymentInstrumentPostPaymentNetwork":{"id":"components/schemas/PaymentInstrumentPostPaymentNetwork","kind":"json-schema","title":"Payment Network","data":{"allOf":[{"required":["instrumentType","paymentNetworkName"],"type":"object"},{"$ref":"#/components/schemas/PaymentNetwork"},{"$ref":"#/components/schemas/hideFailureReason"},{"$ref":"#/components/schemas/SendNoticePaymentMethodAdded"}],"title":"Payment Network"}},"components/schemas/PaymentInstrumentPostPayroll":{"id":"components/schemas/PaymentInstrumentPostPayroll","kind":"json-schema","title":"Payroll","data":{"allOf":[{"required":["instrumentType","employerName"],"type":"object"},{"$ref":"#/components/schemas/Payroll"},{"$ref":"#/components/schemas/hideFailureReason"},{"$ref":"#/components/schemas/SendNoticePaymentMethodAdded"}],"title":"Payroll"}},"components/schemas/PlaidToken":{"id":"components/schemas/PlaidToken","kind":"json-schema","title":"Plaid Link","data":{"example":{"accessToken":"public-sandbox-deadbeef-dead-beef-dead-beefdeadbeef","accountIds":["BnyjkeaawGiG7xgvV5noipAbVe6Edafwx3n97"],"instrumentType":"plaid"},"properties":{"accessToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided by Plaid Link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Plaid Link tokens are associated with a specific Plaid API key. If you are performing a Plaid Link in your app/website"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and pass it to the Peach API you will first need to set your Plaid API key in the Peach API. Please contact Peach Support"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to get access to the Plaid API Key setting endpoint and instructions on how to use it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to use your own Plaid Link token in the sandbox environment, please contact Peach Support as you might need"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to configure your Plaid sandbox account in a certain way."},"children":[]}]}]}],"type":"string"},"accountIds":{"description":"List of Plaid account IDs selected by user, provided by Plaid Link\n","items":{"type":"string"},"type":"array"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lender's identifier for the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fetch the object using externalId you need to add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Don't add ext- to the identifier value. For example: if the external identifier is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABCDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass externalId=ACBCE and NOT ext-ABCDE when creating the object."},"children":[]}]}]}],"minLength":1,"nullable":true,"type":"string"},"instrumentType":{"enum":["plaid"],"type":"string"}},"required":["accessToken","accountIds"],"title":"Plaid Link","type":"object"}},"components/schemas/PaymentInstrumentPostPlaid":{"id":"components/schemas/PaymentInstrumentPostPlaid","kind":"json-schema","title":"Plaid Account","data":{"allOf":[{"$ref":"#/components/schemas/PlaidToken"},{"$ref":"#/components/schemas/BankAccountMutableFields"},{"$ref":"#/components/schemas/hideFailureReason"},{"$ref":"#/components/schemas/SendNoticePaymentMethodAdded"},{"properties":{"accountLink":{"readOnly":true},"accountType":{"readOnly":true}},"type":"object"}],"title":"Plaid Account"}},"components/schemas/wireAccountNumber":{"id":"components/schemas/wireAccountNumber","kind":"json-schema","title":"wireAccountNumber","data":{"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number from where the wire was sent. Must consist of only digits."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the last two, three, or four digits of the account number can be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide four digits if available, otherwise provide two or three digits."},"children":[]}]}]}],"pattern":"^[0-9]+$","type":"string","writeOnly":true}},"type":"object"}},"components/schemas/PaymentInstrumentPostWire":{"id":"components/schemas/PaymentInstrumentPostWire","kind":"json-schema","title":"Wire","data":{"allOf":[{"$ref":"#/components/schemas/Wire"},{"$ref":"#/components/schemas/wireAccountNumber"},{"$ref":"#/components/schemas/hideFailureReason"}],"title":"Wire"}},"components/schemas/PaymentInstrumentPost":{"id":"components/schemas/PaymentInstrumentPost","kind":"json-schema","title":"PaymentInstrumentPost","data":{"discriminator":{"mapping":{"bankAccount":"#/components/schemas/PaymentInstrumentPostBankAccount","card":"#/components/schemas/PaymentInstrumentPostCard","check":"#/components/schemas/PaymentInstrumentPostCheck","moneyOrder":"#/components/schemas/PaymentInstrumentPostMoneyOrder","paymentNetwork":"#/components/schemas/PaymentInstrumentPostPaymentNetwork","payroll":"#/components/schemas/PaymentInstrumentPostPayroll","plaid":"#/components/schemas/PaymentInstrumentPostPlaid","wire":"#/components/schemas/PaymentInstrumentPostWire"},"propertyName":"instrumentType"},"oneOf":[{"$ref":"#/components/schemas/PaymentInstrumentPostBankAccount"},{"$ref":"#/components/schemas/PaymentInstrumentPostCard"},{"$ref":"#/components/schemas/PaymentInstrumentPostCheck"},{"$ref":"#/components/schemas/PaymentInstrumentPostPayroll"},{"$ref":"#/components/schemas/PaymentInstrumentPostPaymentNetwork"},{"$ref":"#/components/schemas/PaymentInstrumentPostPlaid"},{"$ref":"#/components/schemas/PaymentInstrumentPostMoneyOrder"},{"$ref":"#/components/schemas/PaymentInstrumentPostWire"}]}},"components/schemas/PaymentInstrument":{"id":"components/schemas/PaymentInstrument","kind":"json-schema","title":"PaymentInstrument","data":{"oneOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/PaymentCard"},{"$ref":"#/components/schemas/PaymentCheck"},{"allOf":[{"required":["instrumentType","employerName"],"type":"object"},{"$ref":"#/components/schemas/Payroll"}],"title":"Payroll"},{"allOf":[{"required":["instrumentType","paymentNetworkName"],"type":"object"},{"$ref":"#/components/schemas/PaymentNetwork"}],"title":"Payment Network"},{"$ref":"#/components/schemas/MoneyOrder"},{"$ref":"#/components/schemas/Wire"}]}},"components/schemas/SendNoticePaymentMethodUpdated":{"id":"components/schemas/SendNoticePaymentMethodUpdated","kind":"json-schema","title":"SendNoticePaymentMethodUpdated","data":{"properties":{"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodUpdated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PaymentCardMutable":{"id":"components/schemas/PaymentCardMutable","kind":"json-schema","title":"Card","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentMutableFields"},{"$ref":"#/components/schemas/PaymentCardMutableFields"}],"title":"Card"}},"components/schemas/PaymentInstrumentMutable":{"id":"components/schemas/PaymentInstrumentMutable","kind":"json-schema","title":"PaymentInstrumentMutable","data":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/BankAccountMutable"},{"$ref":"#/components/schemas/SendNoticePaymentMethodUpdated"}]},{"allOf":[{"$ref":"#/components/schemas/PaymentCardMutable"},{"$ref":"#/components/schemas/SendNoticePaymentMethodUpdated"}]},{"$ref":"#/components/schemas/PaymentCheckMutable"},{"allOf":[{"$ref":"#/components/schemas/Payroll"},{"$ref":"#/components/schemas/SendNoticePaymentMethodUpdated"}]},{"allOf":[{"$ref":"#/components/schemas/PaymentNetwork"},{"$ref":"#/components/schemas/SendNoticePaymentMethodUpdated"}]}]}},"components/schemas/AccountLinkUpdate":{"id":"components/schemas/AccountLinkUpdate","kind":"json-schema","title":"AccountLinkUpdate","data":{"properties":{"dataServices":{"default":["accountInfo"],"description":"A list of data services available with this link.","items":{"enum":["accountInfo","balance"],"type":"string"},"type":"array"},"lastErrorCommunicationAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time that the most recent error notification was sent to the user. When updated, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorCommunicationsSent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is incremented."},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"}},"components/schemas/AccountLinkBalanceEntry":{"id":"components/schemas/AccountLinkBalanceEntry","kind":"json-schema","title":"AccountLinkBalanceEntry","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"availableBalanceAmount":{"description":"Indicates the balance that is available to spend net of any pending transactions. This balance should be used for insufficient funds (NSF) prevention use case.","format":"float","type":"number"},"createdAt":{"description":"The date and time when this entry was fetched from the account link."},"currency":{"description":"The currency used. Use ISO currency codes.","type":"string"},"currentBalanceAmount":{"description":"Indicates the current balance that does not take pending transactions into account.","format":"float","type":"number"},"error":{"allOf":[{"description":"If present, details of the error returned from the account link."},{"$ref":"#/components/schemas/AccountLinkError"}]},"lastSuccessfulBalance":{"description":"The most recent balance data from a successful check. If the most recent balance check resulted in an error, this object is populated with last successfully fetched balances, if they exist.","properties":{"availableBalanceAmount":{"description":"Indicates the balance that is available to spend net of any pending transactions. This balance should be used for insufficient funds (NSF) prevention use case.","format":"float","type":"number"},"createdAt":{"description":"The date and time when this data was fetched from the account link.","format":"date-time","type":"string"},"currency":{"description":"The currency used. Use ISO currency codes.","type":"string"},"currentBalanceAmount":{"description":"Indicates the current balance that does not take pending transactions into account.","format":"float","type":"number"}},"type":"object"}},"type":"object"}]}},"components/schemas/VerificationAttempt":{"id":"components/schemas/VerificationAttempt","kind":"json-schema","title":"VerificationAttempt","data":{"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"isSuccess":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this attempt to answer the questions was successful."},"children":[]}]}]}],"readOnly":true,"type":"boolean"}},"type":"object"}},"components/schemas/VerificationQuestionCategory":{"id":"components/schemas/VerificationQuestionCategory","kind":"json-schema","title":"VerificationQuestionCategory","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category of questions to include."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inBorrowerPortal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the answer to this question can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be found in the borrower portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"knownToBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the answer to this question"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not found in borrower portal (and therefore must be known by the borrower)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the answer to this question was preconfigured by the borrower previously."},"children":[]}]}]}]}],"enum":["inBorrowerPortal","knownToBorrower","presetSecret"],"type":"string"}},"components/schemas/VerificationQuestion":{"id":"components/schemas/VerificationQuestion","kind":"json-schema","title":"VerificationQuestion","data":{"properties":{"category":{"$ref":"#/components/schemas/VerificationQuestionCategory"},"id":{"type":"string"},"memo":{"description":"The text of the memo for the agent\n","type":"string"},"text":{"description":"The text of the question\n","type":"string"}},"type":"object"}},"components/schemas/VerificationStatus":{"id":"components/schemas/VerificationStatus","kind":"json-schema","title":"VerificationStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verification is pending and answers can still be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verification was successfully completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verification failed—the maximum number of answer attempts was reached."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficientKnowledge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verification could not be created because there is not enough information about the person to generate questions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verification timed out and was expired."},"children":[]}]}]}]}],"enum":["failed","pending","succeeded","expired","insufficientKnowledge"],"readOnly":true,"type":"string"}},"components/schemas/Verification":{"id":"components/schemas/Verification","kind":"json-schema","title":"verification","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":"Object describes a borrower verification process. When a borrower initiates a phone call their\nidentity should be verified before they are allowed to make changes to their account.\n","properties":{"agentUserId":{"description":"An identifier of the agent performing the verification\n","readOnly":true,"type":"string"},"attempts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the attempts to answer the questions associated with this borrower verification."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The responses are intentionally not included for privacy and security. There can only be a maximum"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAttempts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". There can only be one successful attempt. A successful attempt is one with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/VerificationAttempt"},"readOnly":true,"type":"array"},"expiresAt":{"format":"date-time","readOnly":true,"type":"string"},"maxAttempts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of times an attempt can be made to answer all the questions. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAttempts"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are made without success, then this verification's status is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"type":"integer"},"object":{"default":"verification","enum":["verification"],"readOnly":true,"type":"string"},"personId":{"description":"An identifier of the borrower\n","readOnly":true,"type":"string"},"questions":{"description":"The questions that were generated and must be answered.\n","items":{"$ref":"#/components/schemas/VerificationQuestion"},"readOnly":true,"type":"array"},"status":{"$ref":"#/components/schemas/VerificationStatus","readOnly":true}},"type":"object"}],"title":"verification"}},"components/schemas/VerificationsPaging":{"id":"components/schemas/VerificationsPaging","kind":"json-schema","title":"VerificationsPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Verification"},"type":"array"}},"type":"object"}]}},"components/schemas/VerificationPost":{"id":"components/schemas/VerificationPost","kind":"json-schema","title":"VerificationPost","data":{"properties":{"verificationTypeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the borrower verification type to use when creating the verification."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then use the default borrower verification type."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/VerificationAttemptPost":{"id":"components/schemas/VerificationAttemptPost","kind":"json-schema","title":"VerificationAttemptPost","data":{"properties":{"answers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of answers to the questions for this verification. Ordering is not important, but the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"questionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match the ID of the question to which the answer corresponds. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"answers must match the stored information about the borrower in order for the verification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be successful."},"children":[]}]}]}],"items":{"properties":{"questionId":{"description":"The identifier for the question being answered.\n","type":"string"},"text":{"description":"The response text. This must match the stored information about the user.\nDifferent questions have different methods for matching the response text. For instance, some\nquestions will match in a case-insensitive manner, or expect a date-formatted string, or\nallow for a few misspelled characters (e.g., in a name).\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Supercase":{"id":"components/schemas/Supercase","kind":"json-schema","title":"Supercase","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"autoCreated":{"description":"True if the supercase was created by some automated method.\n","type":"boolean"},"companyId":{"description":"The company's ID","readOnly":true,"type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the supercase.\nCan be an agent or automated system process.\n"},"description":{"description":"A description of the supercase and/or the precipitating event\nof the supercase.\n","nullable":true,"type":"string"},"eventStartedAt":{"description":"The date and time at which the precipitating event took place. For instance, in the\ncase of a bug, the earliest date at which the bug affected customers; in the case\nof a disaster, the date at which the disaster occurred.\n","format":"date-time","nullable":true,"type":"string"},"femaDisasterDetails":{"description":"The details of the associated FEMA disaster.","nullable":true,"properties":{"beginDate":{"description":"Date the incident itself began.","format":"date","nullable":true,"type":"string"},"declarationDate":{"description":"Date the disaster was declared.\n","format":"date","type":"string"},"description":{"type":"string"},"endDate":{"description":"Date the incident itself ended.","format":"date","nullable":true,"type":"string"},"hmProgramDeclared":{"description":"Denotes whether the Hazard Mitigation program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"iaProgramDeclared":{"description":"Denotes whether the Individual Assistance program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"ihProgramDeclared":{"description":"Denotes whether the Individuals and Households program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"},"impactedAreas":{"items":{"properties":{"countyArea":{"type":"string"},"placeCode":{"type":"string"},"state":{"type":"string"}},"type":"object"},"type":"array"},"incidentType":{"description":"Type of incident such as fire or flood. The incident type will\naffect the types of assistance available. For more information on\nincident types, please visit: www.fema.gov.\n","maxLength":100,"type":"string"},"lastRefreshAt":{"description":"Date the record was last updated in the FEMA API data store.","format":"date-time","nullable":true,"type":"string"},"paProgramDeclared":{"description":"Denotes whether the Public Assistance program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n","type":"boolean"}},"readOnly":true,"type":"object"},"femaDisasterNumber":{"description":"The associated FEMA disaster number.\n","type":"integer"},"femaMonitoringEndDate":{"description":"If set, the FEMA supercase monitoring will stop after this date.\n","format":"date","nullable":true,"type":"string"},"name":{"description":"Name of the supercase.","maxLength":128,"type":"string"},"object":{"default":"supercase","enum":["supercase"],"readOnly":true,"type":"string"},"outcome":{"$ref":"#/components/schemas/ProcessOutcome"},"status":{"$ref":"#/components/schemas/ProcessStatus"},"statusUpdatedAt":{"description":"The date and time at which the status was last updated on this supercase.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"subcaseName":{"description":"The name of the subcase which will be used when creating new subcases for this supercase.\n","nullable":true,"type":"string"},"subcaseTypeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the case-type which will be used when creating new subcases for this supercase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a population is committed (by settings its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDraft: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") subcases of this type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are created for all members of the population."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supercaseType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be NOT null in order to commit a population."},"children":[]}]}]}]}],"nullable":true,"type":"string"},"supercaseType":{"$ref":"#/components/schemas/SupercaseType"}},"type":"object"}],"description":"A supercase allows for the management of many subcases. It is useful, for\ninstance, when there is an issue which effects a large group of borrowers.\n"}},"components/schemas/SupercaseCollection":{"id":"components/schemas/SupercaseCollection","kind":"json-schema","title":"SupercaseCollection","data":{"items":{"$ref":"#/components/schemas/Supercase"},"type":"array"}},"components/schemas/BulkSendRequestBody":{"id":"components/schemas/BulkSendRequestBody","kind":"json-schema","title":"BulkSendRequestBody","data":{"properties":{"attachments":{"description":"An optional list of documents to attach to the outgoing email.\n","items":{"description":"A document descriptor ID.","type":"string"},"type":"array"},"channel":{"$ref":"#/components/schemas/InteractionChannel"},"context":{"type":"object"},"isTransactional":{"type":"boolean"},"subject":{"$ref":"#/components/schemas/InteractionSubject"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"required":["subject"],"type":"object"}},"components/schemas/SupercaseBulkOperation":{"id":"components/schemas/SupercaseBulkOperation","kind":"json-schema","title":"SupercaseBulkOperation","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"casesFailed":{"description":"The number of cases on which the operation failed.","type":"integer"},"casesIneligible":{"description":"The number of cases on which the operation could not succeed due\nto external factors. For example, if your operation requires the\nsubcase to be open to have any meaningful effect, then a closed\nsubcase would be considered ineligible.\n","type":"integer"},"casesProcessed":{"description":"The total number of processed and/or ineligible subcases.","type":"integer"},"completed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if operation is completed."},"children":[]}]}]}],"type":"boolean"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the supercase.\nCan be an agent or automated system process.\n"},"errorLog":{"description":"List of error reports for each failed subcase level operations.","items":{"type":"object"},"type":"array"},"finishedAt":{"description":"The time operation finished.","format":"date-time","type":"string"},"object":{"default":"SupercaseBulkOperation","enum":["SupercaseBulkOperation"],"readOnly":true,"type":"string"},"startedAt":{"description":"The time operation started.","format":"date-time","type":"string"},"supercaseId":{"readOnly":true,"type":"string"}},"type":"object"},{"anyOf":[{"properties":{"firstInteraction":{"nullable":true,"type":"object"},"noteId":{"nullable":true,"type":"string"},"operationType":{"description":"The different types of bulk operations.","enum":["update"],"readOnly":true,"type":"string"},"requestBody":{"$ref":"#/components/schemas/CasePut","description":"The body of the bulk operation request","readOnly":true}},"title":"update","type":"object"},{"properties":{"firstInteraction":{"$ref":"#/components/schemas/Interaction"},"noteId":{"nullable":true,"type":"string"},"operationType":{"description":"The different types of bulk operations.","enum":["sendMessage"],"readOnly":true,"type":"string"},"requestBody":{"$ref":"#/components/schemas/BulkSendRequestBody","description":"The body of the bulk operation request","readOnly":true}},"title":"sendMessage","type":"object"},{"properties":{"firstInteraction":{"nullable":true,"type":"object"},"noteId":{"nullable":true,"type":"string"},"operationType":{"description":"The different types of bulk operations.","enum":["createDoNotInteract"],"readOnly":true,"type":"string"},"requestBody":{"$ref":"#/components/schemas/DoNotInteract","description":"The body of the bulk operation request","readOnly":true}},"title":"createDoNotInteract","type":"object"},{"properties":{"firstInteraction":{"nullable":true,"type":"object"},"noteId":{"nullable":true,"type":"string"},"operationType":{"description":"The different types of bulk operations.","enum":["deleteDoNotInteract"],"readOnly":true,"type":"string"},"requestBody":{"nullable":true,"readOnly":true,"type":"object"}},"title":"deleteDoNotInteract","type":"object"},{"properties":{"firstInteraction":{"nullable":true,"type":"object"},"noteId":{"nullable":false,"type":"string"},"operationType":{"description":"The different types of bulk operations.","enum":["sendInstructionsByTask"],"readOnly":true,"type":"string"},"requestBody":{"$ref":"#/components/schemas/NoteRequest","description":"The body of the bulk operation request","readOnly":true}},"title":"sendInstructionsByTask","type":"object"}]}]}},"components/schemas/MemberBulkOperationResult":{"id":"components/schemas/MemberBulkOperationResult","kind":"json-schema","title":"MemberBulkOperationResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"borrowerId":{"description":"The ID of the borrower associated with this member","readOnly":true,"type":"string"},"caseId":{"description":"The ID of the subcase associated with this member","readOnly":true,"type":"string"},"populationMembershipId":{"description":"The ID of the population membership","readOnly":true,"type":"string"},"status":{"description":"The status of the bulk operation","enum":["success","failed","notProcessed"],"readOnly":true,"type":"string"},"supercaseBulkOperationId":{"description":"Supercase bulk operation ID","readOnly":true,"type":"string"}},"type":"object"}],"description":"A member bulk operation result represents the result of a bulk operation\non a single member of a supercase population.\n"}},"components/schemas/TargetPopulation":{"id":"components/schemas/TargetPopulation","kind":"json-schema","title":"TargetPopulation","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"populationId":{"description":"The ID of the population","readOnly":true,"type":"string"},"supercaseBulkOperationId":{"description":"Supercase bulk operation ID","readOnly":true,"type":"string"}},"type":"object"}],"description":"A target population represents a committed population that will be affected\nby the supercase bulk operation. Each supercase bulk operation would\nprocess one or more target populations.\n"}},"components/schemas/Population":{"id":"components/schemas/Population","kind":"json-schema","title":"Population","data":{"allOf":[{"$ref":"#/components/schemas/BaseWithExternalIdMixin"},{"properties":{"companyId":{"description":"The unique company identifier.","readOnly":true,"type":"string"},"isDraft":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the draft population of the supercase."},"children":[]}]}]}],"readOnly":true,"type":"boolean"},"object":{"default":"population","enum":["population"],"readOnly":true,"type":"string"},"supercaseId":{"description":"Identifier of the supercase that the population belongs to.","readOnly":true,"type":"string"}},"type":"object"}],"description":"A supercase may affect many borrower-loans. A supercase population represents one instance\nof adding borrower-loans to a supercase. It's important to keep track of which borrower-loans\nwere added at which time, because different actions may need to be taken depending on\nwhen a borrower-loan is added to a supercase.\n"}},"components/schemas/PopulationCollection":{"id":"components/schemas/PopulationCollection","kind":"json-schema","title":"PopulationCollection","data":{"items":{"$ref":"#/components/schemas/Population"},"type":"array"}},"components/schemas/PopulationMember":{"id":"components/schemas/PopulationMember","kind":"json-schema","title":"PopulationMember","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"borrowerId":{"description":"The borrower ID of a borrower affected by this supercase.\n\nYou must specify a borrower in addition to a loan because a loan might have multiple borrowers\nand only one of them might be affected by this supercase.\n","type":"string"},"caseId":{"description":"The ID of the subcase with which this borrower-loan is associated","readOnly":true,"type":"string"},"createdBy":{"$ref":"#/components/schemas/UserActionInfo","description":"Details of the user responsible for creating the member.\nCan be an agent or automated system process.\n"},"loanId":{"description":"The loan ID of a loan affected by this supercase. The loan must be associated with the\nspecified borrower.\n","nullable":true,"type":"string"}},"type":"object"}]}},"components/schemas/PopulationMemberCollection":{"id":"components/schemas/PopulationMemberCollection","kind":"json-schema","title":"PopulationMemberCollection","data":{"items":{"$ref":"#/components/schemas/PopulationMember"},"type":"array"}},"components/schemas/EmployeeBasic":{"id":"components/schemas/EmployeeBasic","kind":"json-schema","title":"EmployeeBasic","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"$ref":"#/components/schemas/EmployeeBase"}]}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"allOf":[{"$ref":"#/components/schemas/UserBasic"},{"properties":{"employee":{"allOf":[{"$ref":"#/components/schemas/EmployeeBasic","nullable":true},{"readOnly":true}]},"person":{"allOf":[{"$ref":"#/components/schemas/Borrower","nullable":true},{"readOnly":true}]}},"type":"object"}]}},"components/schemas/UsersPaging":{"id":"components/schemas/UsersPaging","kind":"json-schema","title":"UsersPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"}]}},"components/schemas/UserUpdate":{"id":"components/schemas/UserUpdate","kind":"json-schema","title":"UserUpdate","data":{"allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"associatedPersonId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrowerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the borrower to be associated with this user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"borrowerId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the borrower to be associated with this user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"roles":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roleIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of role IDs to associate with this user upon creation."},"children":[]}]}]}],"items":{"type":"string"},"nullable":true,"type":"array"},"userType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED ATTRIBUTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["borrower","agent","service"],"type":"string"}},"type":"object"}]}},"components/schemas/UserCreate":{"id":"components/schemas/UserCreate","kind":"json-schema","title":"UserCreate","data":{"allOf":[{"$ref":"#/components/schemas/UserUpdate"},{"properties":{"authType":{"properties":{"email":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"samlSubjectNameId":{"type":"string"}},"type":"object"}},"type":"object"}]}},"components/schemas/NewPassword":{"id":"components/schemas/NewPassword","kind":"json-schema","title":"NewPassword","data":{"properties":{"password":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new password to use. Only applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" auth."},"children":[]}]}]}],"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/NewEmailAuth":{"id":"components/schemas/NewEmailAuth","kind":"json-schema","title":"NewEmailAuth","data":{"allOf":[{"properties":{"email":{"description":"The email address to use for the new auth.\n","type":"string"}},"required":["email"],"type":"object"},{"$ref":"#/components/schemas/NewPassword"}]}},"components/schemas/NewPhoneAuth":{"id":"components/schemas/NewPhoneAuth","kind":"json-schema","title":"NewPhoneAuth","data":{"allOf":[{"properties":{"phone":{"description":"The phone number to use for the new auth.\n","type":"string"}},"required":["phone"],"type":"object"},{"$ref":"#/components/schemas/NewPassword"}]}},"components/schemas/NewSAMLAuth":{"id":"components/schemas/NewSAMLAuth","kind":"json-schema","title":"NewSAMLAuth","data":{"allOf":[{"properties":{"samlSubjectNameId":{"description":"The SAML subject name ID to use for the new auth.\n","type":"string"}},"required":["samlSubjectNameId"],"type":"object"},{"$ref":"#/components/schemas/NewPassword"}]}},"components/schemas/NewAuth":{"id":"components/schemas/NewAuth","kind":"json-schema","title":"NewAuth","data":{"oneOf":[{"$ref":"#/components/schemas/NewEmailAuth"},{"$ref":"#/components/schemas/NewPhoneAuth"},{"$ref":"#/components/schemas/NewSAMLAuth"}]}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":"A permission is assigned to a role, which allows designated users within a company to perform an action\n","properties":{"action":{"description":"The name of the handler function that is allowed","type":"string"},"companyId":{"description":"Unique ID for the company that owns the permission","type":"string"}},"title":"permission","type":"object"}]}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"description":"A role is a collection of permitted actions that can be performed by a user within the context of a single\ncompany.\n","properties":{"alias":{"description":"An optional Human-readable instance name","maxLength":100,"minLength":0,"nullable":true,"type":"string"},"companyId":{"description":"Company that the role is associated with","readOnly":true,"type":"string"},"isSuperAdmin":{"description":"Whether this role has super-admin status. Only super-admin roles can hold super-admin permissions.\nSuper-admin roles are reserved for Peach.\n","readOnly":true,"type":"boolean"},"permissions":{"description":"Array of Permission objects associated with the role","items":{"$ref":"#/components/schemas/Permission"},"nullable":true,"readOnly":true,"type":"array"}},"type":"object"}]}},"components/schemas/RoleCollection":{"id":"components/schemas/RoleCollection","kind":"json-schema","title":"RoleCollection","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Role"},"type":"array"}},"type":"object"}]}},"components/schemas/VerificationQuestionsPaging":{"id":"components/schemas/VerificationQuestionsPaging","kind":"json-schema","title":"VerificationQuestionsPaging","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/VerificationQuestion"},"type":"array"}},"type":"object"}]}},"components/schemas/VerificationType":{"id":"components/schemas/VerificationType","kind":"json-schema","title":"VerificationType","data":{"description":"The object describing how to perform borrower verifications\n","properties":{"enabledQuestionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of question IDs the system will consider when randomly selecting questions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for verification; if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then all available questions will be considered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all"},"href":"#"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See all available questions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"type":"string"},"nullable":true,"type":"array"},"expirationInSecs":{"default":900,"description":"How many seconds each verification session has until it is marked as expired.\n","type":"integer"},"id":{"readOnly":true,"type":"string"},"maxAttemptsPerSession":{"default":3,"description":"The number of attempts to answer the verification questions a borrower is allowed.\n","type":"integer"},"maxSessionsRecentPast":{"default":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Throttles maximum verification sessions a borrower can initiate within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"the recent past\". Where recent past time length is configured via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentPastSecs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"questionSelectionCriteria":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object describing which and how many questions (at a minimum) to select at random."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Only questions with IDs present in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabledQuestionIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be considered.)"},"children":[]}]}]}],"items":{"properties":{"category":{"$ref":"#/components/schemas/VerificationQuestionCategory"},"exactMatchCount":{"description":"The number of questions matching this type to include.\n","type":"integer"}},"type":"object"},"type":"array"},"recentPastSecs":{"default":3600,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds into the past which is considered the \"recent past\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the purposes of throttling verifications. See: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxSessionsRecentPast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"}},"type":"object"}},"components/schemas/VerificationTypesPaging":{"id":"components/schemas/VerificationTypesPaging","kind":"json-schema","title":"VerificationTypesPaging","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/VerificationType"},"type":"array"}},"type":"object"}]}},"components/schemas/eventTypesPublic":{"id":"components/schemas/eventTypesPublic","kind":"json-schema","title":"eventTypesPublic","data":{"enum":["autopay.schedule.cancel","autopay.schedule.changed","autopay.schedule.created","autopay.payment.canceled","autopay.payment.rescheduled","card.created","card.replacement.requested","card.status.changed","case.association.added","case.association.removed","case.donotinteract.created","case.donotinteract.deleted","case.donotinteract.updated","case.donotinteract.changed","case.donotinteract.expired","case.escalation.changed","case.created","case.updated","case.deleted","case.changed","template.descriptor.changed","template.version.changed","template.version.activated","communication.send","indexrate.created","indexrate.updated","installment.refunded","loan.closed","loan.created","loan.current","loan.fee.capitalized","loan.credit.limit.changed","draw.credit.limit.changed","draw.fee.booked","loan.balance.changed","loan.foreigntransactionfee.booked","loan.overdue","loan.overdue.update","loan.interestaccrued.min","loan.interest.capitalized","loan.statuschanged","loan.latefee.booked","loan.migration.succeeded","loan.migration.failed","loan.modificationfee.booked","loan.nsffee.booked","loan.fee.booked","loan.fee.canceled","loan.fee.changed","loan.label.added","loan.label.removed","loan.remainingbalances.deferred","loan.promoprogram.activated","loan.promoprogram.canceled","loan.promoprogram.created","loan.promoprogram.exercised","loan.promoprogram.reactivated","loan.promoprogram.updated","loan.paymentplan.setup","loan.promiseplan.created","loan.promiseplan.statuschanged","loan.promiseplan.due.today","loan.promiseplan.overdue","loan.promiseplan.current","loan.purchasefee.booked","loan.duedate.defer","loan.schedule.defer","loan.ownerchanged","loan.rate.created","loan.rate.updated","loan.refunded","loan.reimbursement.initiated","loan.reimbursement.processed","loan.period.started","loan.obligation.statuschanged","loan.servicefee.booked","loan.membershipfee.booked","statement.created","paymentplan.created","paymentplan.statuschanged","person.created","person.consent.updated","person.monitoring.scra.started","person.monitoring.bankruptcy.started","contact.created","contact.deleted","contact.updated","payment.instrument.created","payment.instrument.updated","payment.instrument.deactivated","interaction.blocked","payment.applied","payment.chargeback","payment.chargeback.reversed","payment.failed","payment.initiated","payment.pending","payment.succeeded","payment.reversed","payment.scheduled","payment.rescheduled","payment.due.today","payment.hold.days.expired","purchase.authorized","purchase.settled","purchase.applied","purchase.changed","purchase.created","purchase.dispute.created","purchase.dispute.updated","loan.creditreporting.created","loan.creditreporting.stopped","ach.file.created","ach.file.upload.attempted","ach.file.upload.failed","ach.file.upload.succeeded","reconciliation.payment.failed","supercase.changed"]}},"components/schemas/WebhookDirectDetails":{"id":"components/schemas/WebhookDirectDetails","kind":"json-schema","title":"WebhookDirectDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details required for Peach to pass the events via webhook. Required only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookType=direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"webhookUrl":{"description":"The URL that Peach will hit when an applicable event fires.\n","type":"string"}},"type":"object"}},"components/schemas/WebhookProxyDetails":{"id":"components/schemas/WebhookProxyDetails","kind":"json-schema","title":"WebhookProxyDetails","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details required for Peach to make an API call to the third party identified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookType=proxyXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"galileoApiLogin":{"description":"The Galileo API login needed to make API calls via Peach's proxy.\n","type":"string","writeOnly":true},"galileoApiTransKey":{"description":"The Galileo API key needed to make API calls via Peach's proxy.\n","type":"string","writeOnly":true},"galileoBaseUrl":{"description":"The Galileo base URL.","type":"string"},"galileoProviderId":{"description":"The Galileo provider ID.","type":"string"}},"type":"object"}},"components/schemas/WebhookSubscriptionPut":{"id":"components/schemas/WebhookSubscriptionPut","kind":"json-schema","title":"WebhookSubscriptionPut","data":{"allOf":[{"$ref":"#/components/schemas/BaseMixin"},{"properties":{"companyId":{"description":"The unique company identifier.\n","readOnly":true,"type":"string"},"enabled":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events will be sent to this webhook, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no events will be sent to it."},"children":[]}]}]}],"type":"boolean"},"hmacSecretKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This automatically generated key will be used to compute the message signature of each request from Peach to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticate the message and validate the message's integrity. Peach uses SHA-256 to generate the message signature,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which will be passed in the request via a header called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PEACH-HMAC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"type":"string"},"hydrateData":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the amount of information the receiver of webhooks will get. Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookType=direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Peach will provide a minimum amount of data. For example: event identifier, event name, timestamp and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier(s) of associated object(s) (e.g. loan ID, borrower ID, transaction ID, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - in addition to the data provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option, Peach will provide full details of the object(s)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the event."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we support hydrating the following objects:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"borrower"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case"},"children":[]}]}]}]}],"type":"boolean"},"webhookDirectDetails":{"$ref":"#/components/schemas/WebhookDirectDetails"},"webhookProxyDetails":{"$ref":"#/components/schemas/WebhookProxyDetails"}},"type":"object"}]}},"components/schemas/WebhookSubscription":{"id":"components/schemas/WebhookSubscription","kind":"json-schema","title":"WebhookSubscription","data":{"allOf":[{"properties":{"eventTypes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of events for which the caller will receive webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For any proxy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field should be left empty, and we will automatically send the events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with that specific proxy."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/eventTypesPublic"},{"type":"string"}]},"type":"array"},"webhookType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach supports two ways of receiving webhooks:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - events will be provided directly to the url nominated by the lender, and the event data will match Peach's data format."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proxyGalileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - events will trigger Peach to make specific API calls to Galileo, so Galileo's sub-ledger remains in sync with Peach's ledger."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: when setting webhookType as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proxyGalileo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please work with the Peach team to ensure the API calls you require are configured."},"children":[]}]}]}],"enum":["direct","proxyGalileo"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/WebhookSubscriptionPut"}]}},"schema_5612":{"kind":"json-schema","data":{"minimum":1,"type":"string"},"id":"schema_5612"},"schema_5613":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AppDomainType"},"id":"schema_5613"},"schema_5614":{"kind":"json-schema","data":{"properties":{"userId":{"$ref":"#/components/schemas/AnyId"}},"required":["userId"],"type":"object"},"id":"schema_5614"},"schema_5615":{"kind":"json-schema","data":{"properties":{"data":{"properties":{"exchangeToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A random token that may be exchanged for a real token via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/auth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}],"type":"string"}},"type":"object"}},"type":"object"},"id":"schema_5615"},"schema_5616":{"kind":"json-schema","data":{"anyOf":[{"properties":{"password":{"description":"The password to authenticate with.","format":"password","type":"string"},"username":{"description":"The username to authenticated. This can be a username or an email, depending on the configuration.","type":"string"}},"type":"object"},{"properties":{"exchangeToken":{"description":"Temporary exchange token generated by the /auth/exchange-token endpoint.","type":"string"}},"type":"object"}]},"id":"schema_5616"},"schema_5617":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"$ref":"#/components/schemas/UserPermissions"}]},"id":"schema_5617"},"schema_5618":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserType"},"id":"schema_5618"},"schema_5619":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuthType"},"id":"schema_5619"},"schema_5620":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuthValueType"},"id":"schema_5620"},"schema_5621":{"kind":"json-schema","data":{"properties":{"permissions":{"description":"List of permissions that the short-lived token can have. These can only be permissions that are already given to the calling user.\n","items":{"type":"string"},"type":"array"}},"type":"object"},"id":"schema_5621"},"schema_5622":{"kind":"json-schema","data":{"properties":{"RelayState":{"type":"string"},"SAMLResponse":{"type":"string"}},"required":["SAMLResponse"],"type":"object"},"id":"schema_5622"},"schema_5623":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_5623"},"schema_5624":{"kind":"json-schema","data":{"additionalProperties":false,"properties":{"channel":{"$ref":"#/components/schemas/OneTimeCodeChannel"},"context":{"description":"Template specific properties to substitute in the corresponding\nConfirmationCode template.\n","type":"object"},"force":{"default":false,"description":"Force using the auth type of the user and not the company\n","type":"boolean"},"userType":{"$ref":"#/components/schemas/UserType"},"username":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either an email address or phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the auth type for the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneTimeCodeText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then this must be a valid phone number. Otherwise,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it must be a valid email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to look up the user in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For agents:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user belongs to an agent, then the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used directly as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient email address or phone number to text or call with the one time code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For borrowers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user belongs to a borrower of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is used directly as the recipient email address or phone number to text or call"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the one time code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user belongs to a borrower of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then borrower's primary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affiliation=self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected. And that value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used as the recipient email address or phone number to text or call with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the one time code."},"children":[]}]}]}]}],"type":"string"}},"required":["username","channel"],"type":"object"},"id":"schema_5624"},"schema_5625":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AnyId"},"id":"schema_5625"},"schema_5626":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/UserAuth"}},"type":"object"}]},"id":"schema_5626"},"schema_5627":{"kind":"json-schema","data":{"default":"active","enum":["active","inactive"],"type":"string"},"id":"schema_5627"},"schema_5628":{"kind":"json-schema","data":{"default":25,"maximum":100,"minimum":1,"type":"integer"},"id":"schema_5628"},"schema_5629":{"kind":"json-schema","data":{"minimum":0,"type":"integer"},"id":"schema_5629"},"schema_5630":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResponseAPIKeyNoSecret"},"type":"array"}},"type":"object"}]},"id":"schema_5630"},"schema_5631":{"kind":"json-schema","data":{"enum":["active","inactive"],"type":"string"},"id":"schema_5631"},"schema_5632":{"kind":"json-schema","data":{"items":{"type":"string"},"type":"array"},"id":"schema_5632"},"schema_5633":{"kind":"json-schema","data":{"enum":["business","person"],"type":"string"},"id":"schema_5633"},"schema_5634":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Borrower"}},"type":"object"}]},"id":"schema_5634"},"schema_5635":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/BorrowerNoIdentity"},{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"}},"type":"object"}]},"id":"schema_5635"},"schema_5636":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/BorrowerNoIdentity"}},"type":"object"}]},"id":"schema_5636"},"schema_5637":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Identity"},{"$ref":"#/components/schemas/CaseId"},{"required":["value","identityType"]}]},"id":"schema_5637"},"schema_5638":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Identity"}},"type":"object"}]},"id":"schema_5638"},"schema_5639":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/IdentityPut"},{"$ref":"#/components/schemas/CaseId"}]},"id":"schema_5639"},"schema_5640":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ContactType"},"id":"schema_5640"},"schema_5641":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ContactAffiliation"},"id":"schema_5641"},"schema_5642":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ContactLabel"},"id":"schema_5642"},"schema_5643":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ContactStatus"},"id":"schema_5643"},"schema_5644":{"kind":"json-schema","data":{"default":true,"type":"boolean"},"id":"schema_5644"},"schema_5645":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactInformation"},"type":"array"}},"type":"object"}]},"id":"schema_5645"},"schema_5646":{"kind":"json-schema","data":{"pattern":"^\\d{6}$","type":"string"},"id":"schema_5646"},"schema_5647":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/ContactInformation"}},"type":"object"}]},"id":"schema_5647"},"schema_5648":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"},{"properties":{"errorType":{"enum":["ConfirmationCodeAttemptsExceeded"],"type":"string"},"status":{"enum":[429],"type":"integer"}},"type":"object"}]},"id":"schema_5648"},"schema_5649":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/components/schemas/PaymentInstrumentGet"},"type":"array"}},"required":["count","data"],"type":"object"}],"title":"Payment Instruments"},"id":"schema_5649"},"schema_5650":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/components/schemas/PaymentInstrument"},"type":"array"}},"required":["count","data"],"type":"object"}],"title":"Payment Instruments"},"id":"schema_5650"},"schema_5651":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentInstrumentGet"}},"type":"object"}]},"id":"schema_5651"},"schema_5652":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentMutable"}]},"id":"schema_5652"},"schema_5653":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/AccountLink"}},"type":"object"}]},"id":"schema_5653"},"schema_5654":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/AccountLinkBalanceEntry"}},"type":"object"}]},"id":"schema_5654"},"schema_5655":{"kind":"json-schema","data":{"properties":{"deposit1":{"type":"integer"},"deposit2":{"type":"integer"}},"required":["deposit1","deposit2"],"type":"object"},"id":"schema_5655"},"schema_5656":{"kind":"json-schema","data":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"},"id":"schema_5656"},"schema_5657":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DocumentUploadLink"},"type":"array"},"id":"schema_5657"},"schema_5658":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DocumentType"},"type":"array"},"id":"schema_5658"},"schema_5659":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DocumentDescriptorResponse"},"type":"array"},"id":"schema_5659"},"schema_5660":{"kind":"json-schema","data":{"enum":["inline","attachment"],"type":"string"},"id":"schema_5660"},"schema_5661":{"kind":"json-schema","data":{"format":"binary","type":"string"},"id":"schema_5661"},"schema_5662":{"kind":"json-schema","data":{"properties":{"file":{"format":"binary","type":"string"}},"type":"object"},"id":"schema_5662"},"schema_5663":{"kind":"json-schema","data":{"enum":["pdf"],"type":"string"},"id":"schema_5663"},"schema_5664":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LegalRepresentative"}},"type":"object"}]},"id":"schema_5664"},"schema_5665":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Verification"}},"type":"object"}]},"id":"schema_5665"},"schema_5666":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"message":{"description":"A description of the error.","type":"string"}},"type":"object"}]},"id":"schema_5666"},"schema_5667":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"nextVerificationOkAt":{"format":"date-time","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5667"},"schema_5668":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/VerificationAttempt"}},"type":"object"}]},"id":"schema_5668"},"schema_5669":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/VerificationType"}},"type":"object"}]},"id":"schema_5669"},"schema_5670":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/BorrowerCampaignFull"},"type":"array"}},"type":"object"}]},"id":"schema_5670"},"schema_5671":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/BorrowerCampaignFull"}},"type":"object"}]},"id":"schema_5671"},"schema_5672":{"kind":"json-schema","data":{"nullable":true,"properties":{"queryResultsOverride":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of running the Redash query specified in the Campaign object at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryRedashUrl"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can overide that query by providing a query results override."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of the query being run and its results being used as campaign input, the data provided here"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is fed into the campaign as input."},"children":[]}]}]}],"example":[{"borrowerId":1,"loanId":101},{"borrowerId":2,"loanId":102},{"borrowerId":3,"loanId":103}],"type":"array"}},"type":"object"},"id":"schema_5672"},"schema_5673":{"kind":"json-schema","data":{"default":"all","enum":["all","query_results.csv","campaign_input.json","contacts.csv","log.txt"],"type":"string"},"id":"schema_5673"},"schema_5674":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactExporter"},"type":"array"}},"type":"object"}]},"id":"schema_5674"},"schema_5675":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/ContactExporter"}},"type":"object"}]},"id":"schema_5675"},"schema_5676":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/BulkSender"},"type":"array"}},"type":"object"}]},"id":"schema_5676"},"schema_5677":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/BulkSender"}},"type":"object"}]},"id":"schema_5677"},"schema_5678":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CaseEscalationDetailed"},"type":"array"}},"type":"object"}]},"id":"schema_5678"},"schema_5679":{"kind":"json-schema","data":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":"schema_5679"},"schema_5680":{"kind":"json-schema","data":{"enum":["all","documents","cases","interactions","loans"],"type":"string"},"id":"schema_5680"},"schema_5681":{"kind":"json-schema","data":{"enum":["all","approved","denied","falsePositive","noOutcome"],"type":"string"},"id":"schema_5681"},"schema_5682":{"kind":"json-schema","data":{"enum":["all","initiated","processing","completed","canceled","reopened"],"type":"string"},"id":"schema_5682"},"schema_5683":{"kind":"json-schema","data":{"items":{"enum":["all","initiated","processing","completed","canceled","reopened"],"type":"string"},"type":"array"},"id":"schema_5683"},"schema_5684":{"kind":"json-schema","data":{"enum":["generic","bankruptcy","ceaseCommunication","collection","deceased","disputeOfDebt","federalEmergency","identityTheft","legalAction","militaryDuty","debtValidation","oFACSanctionedIndividual","creditBureauDispute"],"type":"string"},"id":"schema_5684"},"schema_5685":{"kind":"json-schema","data":{"items":{"enum":["none","lineOfCredit","installment"],"type":"string"},"type":"array"},"id":"schema_5685"},"schema_5686":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionStatus"},"type":"array"},"id":"schema_5686"},"schema_5687":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionChannel"},"type":"array"},"id":"schema_5687"},"schema_5688":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Case"},"type":"array"}},"type":"object"}]},"id":"schema_5688"},"schema_5689":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Case"}},"type":"object"}]},"id":"schema_5689"},"schema_5690":{"kind":"json-schema","data":{"enum":["document","case","interaction","loan","transaction"],"type":"string"},"id":"schema_5690"},"schema_5691":{"kind":"json-schema","data":{"default":"related","enum":["causes","blocks","duplicate","related"],"type":"string"},"id":"schema_5691"},"schema_5692":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CaseEscalation"},"type":"array"}},"type":"object"}]},"id":"schema_5692"},"schema_5693":{"kind":"json-schema","data":{"properties":{"snoozeFor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days to snooze for. To cancel snoozing set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the current time has caught up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozedUntil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date then setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozeFor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also causes the snooze to \"pop\" which initiates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a case review task into the task system."},"children":[]}]}]}],"minimum":1,"nullable":true,"type":"integer"}},"required":["snoozeFor"],"type":"object"},"id":"schema_5693"},"schema_5694":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AnyId"},"type":"array"},"id":"schema_5694"},"schema_5695":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CaseType"},"type":"array"}},"type":"object"}]},"id":"schema_5695"},"schema_5696":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CaseType"}},"type":"object"}]},"id":"schema_5696"},"schema_5697":{"kind":"json-schema","data":{"format":"int32","type":"integer"},"id":"schema_5697"},"schema_5698":{"kind":"json-schema","data":{"enum":["doNotInteractType","notificationType","loanType"],"type":"string"},"id":"schema_5698"},"schema_5699":{"kind":"json-schema","data":{"properties":{"data":{"properties":{"caseTypeId":{"description":"Case type this task creation run was performed on","type":"string"},"completedAt":{"format":"date-time","type":"string"},"createdTasks":{"properties":{"count":{"description":"Number of reminder tasks created","type":"number"},"taskLog":{"additionalProperties":{"example":{"CE-XXXX-XXXX":{"caseValue":"2023-07-31T19:07:00Z","creatingRule":"keyDates.importantDate"}},"properties":{"caseValue":{"description":"The value on the case that triggered task creation"},"creatingRule":{"description":"The smart reviews rule that triggered task creation","type":"string"}},"type":"object"},"type":"object"}},"type":"object"},"smartReviewsConfig":{"description":"Smart reviews configuration for the case type as of the\ntask creation run\n","type":"object"}},"type":"object"}},"type":"object"},"id":"schema_5699"},"schema_5700":{"kind":"json-schema","data":{"items":{"enum":["-id","id","+id","-createdAt","createdAt","+createdAt","-name","name","+name","-status","status","+status"],"type":"string"},"type":"array"},"id":"schema_5700"},"schema_5701":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SupercaseType","default":"generic"},"id":"schema_5701"},"schema_5702":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_5702"},"schema_5703":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProcessStatus"},"type":"array"},"id":"schema_5703"},"schema_5704":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"$ref":"#/components/schemas/SupercaseCollection"}},"type":"object"}]},"id":"schema_5704"},"schema_5705":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Supercase"},{"required":["supercaseType"]}]},"id":"schema_5705"},"schema_5706":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Supercase"}},"type":"object"}]},"id":"schema_5706"},"schema_5707":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"operationId":{"description":"The ID of the newly created bulk operation object","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5707"},"schema_5708":{"kind":"json-schema","data":{"items":{"enum":["update","sendMessage","createDoNotInteract","deleteDoNotInteract","sendInstructionsByTask"],"type":"string"},"type":"array"},"id":"schema_5708"},"schema_5709":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/SupercaseBulkOperation"},"type":"array"}},"type":"object"}]},"id":"schema_5709"},"schema_5710":{"kind":"json-schema","data":{"allOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/SupercaseBulkOperation"},"type":"array"}},"type":"object"}]},"id":"schema_5710"},"schema_5711":{"kind":"json-schema","data":{"enum":["success","failed","ineligible","notProcessed"],"type":"string"},"id":"schema_5711"},"schema_5712":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/MemberBulkOperationResult"},"type":"array"}},"type":"object"}]},"id":"schema_5712"},"schema_5713":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/TargetPopulation"},"type":"array"}},"type":"object"}]},"id":"schema_5713"},"schema_5714":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"caseCount":{"description":"The number of cases associated with the supercase","type":"integer"}},"type":"object"}},"type":"object"}]},"id":"schema_5714"},"schema_5715":{"kind":"json-schema","data":{"oneOf":[{"description":"List of document IDs to associated with the supercase.\n","items":{"description":"A document descriptor ID.","type":"string"},"type":"array"},{"description":"List of documents associated with the supercase.","items":{"$ref":"#/components/schemas/DocumentDescriptorResponse"},"type":"array"}]},"id":"schema_5715"},"schema_5716":{"kind":"json-schema","data":{"description":"List of document IDs.\n","items":{"description":"A document descriptor ID.","type":"string"},"type":"array"},"id":"schema_5716"},"schema_5717":{"kind":"json-schema","data":{"default":null,"nullable":true,"type":"boolean"},"id":"schema_5717"},"schema_5718":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/NoteResponse"},"type":"array"}},"type":"object"}]},"id":"schema_5718"},"schema_5719":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/NoteResponse"}},"type":"object"}]},"id":"schema_5719"},"schema_5720":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"$ref":"#/components/schemas/PopulationCollection"}},"type":"object"}]},"id":"schema_5720"},"schema_5721":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Population"}},"type":"object"}]},"id":"schema_5721"},"schema_5722":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PopulationMemberCollection"}},"type":"object"}]},"id":"schema_5722"},"schema_5723":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DoNotInteract"},"type":"array"}},"type":"object"}]},"id":"schema_5723"},"schema_5724":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/DoNotInteract"}},"type":"object"}]},"id":"schema_5724"},"schema_5725":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DoNotInteractType"},"type":"array"}},"type":"object"}]},"id":"schema_5725"},"schema_5726":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/DoNotInteractType"}},"type":"object"}]},"id":"schema_5726"},"schema_5727":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotificationType"},"type":"array"}},"type":"object"}]},"id":"schema_5727"},"schema_5728":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/NotificationType"}},"type":"object"}]},"id":"schema_5728"},"schema_5729":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/NoteCategory"},"type":"array"},"id":"schema_5729"},"schema_5730":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Workflow"}},"type":"object"}]},"id":"schema_5730"},"schema_5731":{"kind":"json-schema","data":{"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkflowStepStatus","required":true}},"type":"object"},"id":"schema_5731"},"schema_5732":{"kind":"json-schema","data":{"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkflowWorkitemStatus","required":true}},"type":"object"},"id":"schema_5732"},"schema_5733":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkflowStepType"},"type":"array"}},"type":"object"}]},"id":"schema_5733"},"schema_5734":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/WorkflowStepType"}},"type":"object"}]},"id":"schema_5734"},"schema_5735":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkflowType"},"type":"array"}},"type":"object"}]},"id":"schema_5735"},"schema_5736":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/WorkflowType"}},"type":"object"}]},"id":"schema_5736"},"schema_5737":{"kind":"json-schema","data":{"default":"json","enum":["json","yaml"],"type":"string"},"id":"schema_5737"},"schema_5738":{"kind":"json-schema","data":{"items":{"type":"object"},"type":"array"},"id":"schema_5738"},"schema_5739":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use JSON or YAML format instead."},"children":[]}]}]}],"format":"binary","type":"string"},"id":"schema_5739"},"schema_5740":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkflowWorkitemType"},"type":"array"}},"type":"object"}]},"id":"schema_5740"},"schema_5741":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/WorkflowWorkitemType"}},"type":"object"}]},"id":"schema_5741"},"schema_5742":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TaskQueueData"},"type":"array"},"id":"schema_5742"},"schema_5743":{"kind":"json-schema","data":{"properties":{"taskSids":{"description":"List of task SIDs to delete.\n","items":{"type":"string"},"type":"array"}},"type":"object"},"id":"schema_5743"},"schema_5744":{"kind":"json-schema","data":{"items":{"enum":["reservation"],"type":"string"},"type":"array"},"id":"schema_5744"},"schema_5745":{"kind":"json-schema","data":{"items":{"enum":["pending","reserved","assigned","wrapping"],"type":"string"},"type":"array"},"id":"schema_5745"},"schema_5746":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TaskType"},"type":"array"},"id":"schema_5746"},"schema_5747":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BaseCaseType"},"type":"array"},"id":"schema_5747"},"schema_5748":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Task"},"type":"array"}},"type":"object"},"id":"schema_5748"},"schema_5749":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/Task"}},"type":"object"},"id":"schema_5749"},"schema_5750":{"kind":"json-schema","data":{"items":{"enum":["statsToday"],"type":"string"},"type":"array"},"id":"schema_5750"},"schema_5751":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"availableByDefault":{"type":"object"},"availableByUserConfig":{"type":"object"},"permitted":{"type":"object"}},"type":"object"}},"type":"object"}]},"id":"schema_5751"},"schema_5752":{"kind":"json-schema","data":{"properties":{"availableByUserConfig":{"type":"object"}},"type":"object"},"id":"schema_5752"},"schema_5753":{"kind":"json-schema","data":{"default":["-priority"],"items":{"enum":["id","+id","-id","priority","-priority","+priority","createdAt","+createdAt","-createdAt"],"type":"string"},"type":"array"},"id":"schema_5753"},"schema_5754":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/TaskWorkerPairingConfig"}},"type":"object"}]},"id":"schema_5754"},"schema_5755":{"kind":"json-schema","data":{"default":"all","enum":["all","minimal"],"type":"string"},"id":"schema_5755"},"schema_5756":{"kind":"json-schema","data":{"items":{"enum":["all","active","pending","originated","declined","frozen","accelerated","chargedOff","paidOff","canceled"],"type":"string"},"type":"array"},"id":"schema_5756"},"schema_5757":{"kind":"json-schema","data":{"nullable":true,"type":"boolean"},"id":"schema_5757"},"schema_5758":{"kind":"json-schema","data":{"items":{"enum":["createdAt","+createdAt","-createdAt","updatedAt","+updatedAt","-updatedAt","originatedAt","+originatedAt","-originatedAt","activatedAt","+activatedAt","-activatedAt"],"type":"string"},"type":"array"},"id":"schema_5758"},"schema_5759":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/LoansPaging"},{"$ref":"#/components/schemas/LoansMinimalPaging"}]},"id":"schema_5759"},"schema_5760":{"kind":"json-schema","data":{"enum":["all","hasBalance","zeroBalance"],"type":"string"},"id":"schema_5760"},"schema_5761":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Loan"}},"type":"object"}]},"id":"schema_5761"},"schema_5762":{"kind":"json-schema","data":{"properties":{"atOrigination":{"anyOf":[{"$ref":"#/components/schemas/InstallmentAtOrigination"},{"$ref":"#/components/schemas/LineOfCreditAtOrigination"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object can only be updated when the loan has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"chargedOffReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for the loan charge off. You can only update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOffReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the loan status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off per loan type configuration after X days overdue."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudulent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off for fraudulent reason. If the loan is reported to one or more credit bureaus, the system will automatically send a special request to each bureau to delete the tradeline due to confirmed fraud. This is the only reason that the system will automatically trigger a request to delete the tradeline. For other reasons, if you need to delete the tradeline please call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delete from credit reporting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or use an agent tool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankruptcy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of bankruptcy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the loan was charged off because of some legal reason."},"children":[]}]}]}]}],"enum":["term","fraudulent","bankruptcy","legal"],"type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender's identifier for the loan. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:update.force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to change."},"children":[]}]}]}],"nullable":true,"type":"string"},"metaData":{"$ref":"#/components/schemas/MetaData"},"migration":{"$ref":"#/components/schemas/Migration"},"muteLoanNotices":{"description":"Indicates whether the system should stop/pause sending loan related notices to the borrower. Set to true if you want to mute all loan related notices (e.g. loanDetails. autopayEnabled, paymentFailed, etc.) Keep in mind that it will also stop all notices related to the loan that are sent from Peach Agent Portal by an agent.\nNote: this is not the only attribute that can stop notices from being sent. Compliance Guard and Cases Do Not Interact can also block communications.\n","type":"boolean"},"nickname":{"description":"A nickname the borrower gave the loan.","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/LoanStatus"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new loan status. Note that not every value in the enum is settable via this endpoint:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for Peach-managed loans, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be set here (it is set at loan creation, or by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelling the loan), and most other transitions go through dedicated endpoints (e.g."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activate, charge-off, close). Sending an unsupported transition returns a 4xx error."},"children":[]}]}]}]}},"type":"object"},"id":"schema_5762"},"schema_5763":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanAccelerateResponse"}},"type":"object"}]},"id":"schema_5763"},"schema_5764":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanActivationResponse"}},"type":"object"}]},"id":"schema_5764"},"schema_5765":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanChargeOffResponse"}},"type":"object"}]},"id":"schema_5765"},"schema_5766":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"closeReason":{"$ref":"#/components/schemas/CloseReason"},"closeReasonDetails":{"$ref":"#/components/schemas/CloseReasonDetails"},"closeRequestedByBorrower":{"$ref":"#/components/schemas/CloseRequestedByBorrower"},"sendNotice":{"$ref":"#/components/schemas/LoanCloseSendNotice"}},"type":"object"},"id":"schema_5766"},"schema_5767":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CreditLimitProperties"}},"type":"object"}]},"id":"schema_5767"},"schema_5768":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LineOfCredit"}},"type":"object"}]},"id":"schema_5768"},"schema_5769":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"sendNotice":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will NOT send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loanFreeze"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notice to the borrower."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},"id":"schema_5769"},"schema_5770":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/IsLocked"}},"type":"object"}]},"id":"schema_5770"},"schema_5771":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Transaction"}},"type":"object"}]},"id":"schema_5771"},"schema_5772":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"force":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", reopen the line of credit and all of its draws even when they are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"type":"boolean"},"reopenReason":{"description":"The reason the loan is being reopened.","type":"string"}},"type":"object"},"id":"schema_5772"},"schema_5773":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanReverseAccelerateResponse"}},"type":"object"}]},"id":"schema_5773"},"schema_5774":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanReverseChargeOffResponse"}},"type":"object"}]},"id":"schema_5774"},"schema_5775":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"$ref":"#/components/schemas/ExpectedPaymentsResult"}},"type":"object"}]},"id":"schema_5775"},"schema_5776":{"kind":"json-schema","data":{"properties":{"message":{"enum":["Loan is locked for updates. Please try again.","Loan is locked for updates. Please check back again in a few minutes.","Previous purchase is processing."],"type":"string"}},"type":"object"},"id":"schema_5776"},"schema_5777":{"kind":"json-schema","data":{"enum":["scheduled","pending","settled","canceled"],"type":"string"},"id":"schema_5777"},"schema_5778":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"advances":{"items":{"$ref":"#/components/schemas/Advance"},"type":"array"},"totalAdvancedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total of advances amounts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. In other words, the total of advances that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"were written to the ledger."},"children":[]}]}]}],"format":"float","type":"number"},"totalScheduledAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total of advances amounts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"type":"object"}]},"id":"schema_5778"},"schema_5779":{"kind":"json-schema","data":{"allOf":[{"required":["status","amount","advanceDate"],"title":"Advance","type":"object"},{"$ref":"#/components/schemas/Advance"}]},"id":"schema_5779"},"schema_5780":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Advance"}},"type":"object"}]},"id":"schema_5780"},"schema_5781":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanRefundV2CollectionResponse"}},"type":"object"}]},"id":"schema_5781"},"schema_5782":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanRefund"}},"type":"object"}]},"id":"schema_5782"},"schema_5783":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanRefundV2"}},"type":"object"}]},"id":"schema_5783"},"schema_5784":{"kind":"json-schema","data":{"properties":{"drawFee":{"description":"The draw fee.","format":"float","type":"number"},"duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new duration of the draw as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the line of credit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this endpoint is called when the draw has already been active for some number of periods, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will generate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods from the time at which the endpoint is called. For example, if a draw has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duration 10, and it is amortized again in period 5 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the result will be a draw with a total duration of 15."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The caller needs to pass one of the values only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","type":"integer"},"purchaseAmount":{"description":"The total amount of the purchases for preview.","format":"float","type":"number"},"recurringAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring payment amount. The system will calculate the needed duration. Pass one of the values only,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service fee amount that will be charged recurrently. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[loanPeriod, everyOtherLoanPeriod, calendarPeriod]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=passedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"serviceFeeCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[loanPeriod, everyOtherLoanPeriod, calendarPeriod]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=capPassedAtOrigination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other cases, the system will calculate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the fee based on pre-configured logic."},"children":[]}]}]}],"format":"float","type":"number"},"startDate":{"description":"The start date of the draw. The system will assume today if not specified.","format":"date","type":"string"}},"required":["purchaseAmount"],"type":"object"},"id":"schema_5784"},"schema_5785":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanSchedule"}},"type":"object"}]},"id":"schema_5785"},"schema_5786":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/DrawResponse"}},"type":"object"}]},"id":"schema_5786"},"schema_5787":{"kind":"json-schema","data":{"properties":{"atOrigination":{"$ref":"#/components/schemas/DrawAtOriginationUpdate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object can only be updated when the draw has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"drawType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in which lenders set up draws specifically to be used for cash advances, balance transfers, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashAdvance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - must be set in order for Peach's system to automatically associate ATM withdrawal and other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cash-specific transactions with a specific draw. See Create card issuer endpoint and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute for additional configuration details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw that will house balance transfer transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regularPurchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peach's system will automatically associate purchases with this draw based on the card issuer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drawMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logic."},"children":[]}]}]}],"enum":["balanceTransfer","cashAdvance","regularPurchase"],"nullable":true,"type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lender's identifier for the draw. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loan:update.force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to change."},"children":[]}]}]}],"nullable":true,"type":"string"},"nickname":{"description":"A nickname the borrower gave the draw.","type":"string"},"status":{"$ref":"#/components/schemas/LoanStatus"}},"type":"object"},"id":"schema_5787"},"schema_5788":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/DrawActivationResponse"}},"type":"object"}]},"id":"schema_5788"},"schema_5789":{"kind":"json-schema","data":{"properties":{"duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new duration of the draw as a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the line of credit. Only applicable if the draw"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"needs to be amortized. The caller needs to pass one of the values only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this endpoint is called when the draw has already been active for some number of periods, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will generate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" periods from the time at which the endpoint is called. For example, if a draw has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duration 10, and it is amortized again in period 5 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration=10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the result will be a draw with a total duration of 15."},"children":[]}]}]}],"format":"int32","type":"integer"},"previewMode":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the draw doesn't change, and no changes are saved to the database."},"children":[]}]}]}],"type":"boolean"},"recurringAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring payment amount. The system will calculate the needed duration. Pass one of the values only,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPaymentAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is only valid when the amortizationMethod on the loan type is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equalPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"},"id":"schema_5789"},"schema_5790":{"kind":"json-schema","data":{"additionalProperties":false,"properties":{"cancellationReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation reason:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"technicalIssue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created due to a technical issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wrongLoanTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created with the wrong terms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wrongBorrower"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - loan was created on the wrong borrower."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - for any other reason requiring cancellation."},"children":[]}]}]}],"enum":["technicalIssue","wrongLoanTerms","wrongBorrower","other"],"type":"string"}},"type":"object"},"id":"schema_5790"},"schema_5791":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"closeRequestedByBorrower":{"default":false,"description":"Set to true if a borrower requested to close the account.","type":"boolean"}},"type":"object"},"id":"schema_5791"},"schema_5792":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"properties":{"creditLimitAmount":{"description":"The credit limit amount.","format":"float","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]}},"type":"object"}]},"id":"schema_5792"},"schema_5793":{"kind":"json-schema","data":{"allOf":[{"properties":{"creditLimitAmount":{"description":"The credit limit amount.","format":"float","type":"number"},"creditLimitPercentage":{"$ref":"#/components/schemas/CreditLimitPercentage"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]},"id":"schema_5793"},"schema_5794":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/AtOriginationDynamicFees"}},"type":"object"}]},"id":"schema_5794"},"schema_5795":{"kind":"json-schema","data":{"properties":{"minPaymentCalculation":{"$ref":"#/components/schemas/MinPaymentCalculation"}},"required":["minPaymentCalculation"],"type":"object"},"id":"schema_5795"},"schema_5796":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"force":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", reopen the draw even when it is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paidOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, also reopening its parent line of credit if needed. Sibling draws are not affected."},"children":[]}]}]}],"type":"boolean"},"reopenReason":{"description":"The reason the loan is being reopened.","type":"string"}},"type":"object"},"id":"schema_5796"},"schema_5797":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PurchaseDispute"},"type":"array"}},"type":"object"}]},"id":"schema_5797"},"schema_5798":{"kind":"json-schema","data":{"items":{"enum":["regular","refund","cashback"],"type":"string"},"type":"array"},"id":"schema_5798"},"schema_5799":{"kind":"json-schema","data":{"items":{"enum":["authorized","pending","settled","canceled","declined","disputed"],"type":"string"},"type":"array"},"id":"schema_5799"},"schema_5800":{"kind":"json-schema","data":{"items":{"enum":["effectiveAt","+effectiveAt","-effectiveAt","createdAt","+createdAt","-createdAt"],"type":"string"},"type":"array"},"id":"schema_5800"},"schema_5801":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Purchase"},"type":"array"}},"type":"object"}]},"id":"schema_5801"},"schema_5802":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreatePurchase"},{"$ref":"#/components/schemas/PurchaseExtraInput"}]},"id":"schema_5802"},"schema_5803":{"kind":"json-schema","data":{"items":{"enum":["effectiveAt","authorizedAt","createdAt"],"type":"string"},"type":"array"},"id":"schema_5803"},"schema_5804":{"kind":"json-schema","data":{"enum":["asc","desc"],"type":"string"},"id":"schema_5804"},"schema_5805":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Purchase"}},"type":"object"}]},"id":"schema_5805"},"schema_5806":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PurchaseDispute"},{"properties":{"createDisputeCase":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will automatically create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case object and return the case identifier in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. Alternatively, you can create the case object, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createDisputeCase=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the case identifier in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"required":["disputedAmount"]}]},"id":"schema_5806"},"schema_5807":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PurchaseDispute"}},"type":"object"}]},"id":"schema_5807"},"schema_5808":{"kind":"json-schema","data":{"enum":["experian","equifax","transUnion","innovis"],"type":"string"},"id":"schema_5808"},"schema_5809":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PastPeriod"},"type":"array"}},"type":"object"}]},"id":"schema_5809"},"schema_5810":{"kind":"json-schema","data":{"properties":{"pastPeriods":{"items":{"$ref":"#/components/schemas/PastPeriodWithRequireds"},"type":"array"}},"required":["pastPeriods"],"type":"object"},"id":"schema_5810"},"schema_5811":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PastPeriod"},"type":"array"}},"type":"object"}]},"id":"schema_5811"},"schema_5812":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PastPeriod"}},"type":"object"}]},"id":"schema_5812"},"schema_5813":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TransactionStatusReadOnly"},"type":"array"},"id":"schema_5813"},"schema_5814":{"kind":"json-schema","data":{"enum":["payment","serviceCredit"],"type":"string"},"id":"schema_5814"},"schema_5815":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/serviceCreditTypes"},"type":"array"},"id":"schema_5815"},"schema_5816":{"kind":"json-schema","data":{"items":{"enum":["appliedAt","+appliedAt","-appliedAt","createdAt","+createdAt","-createdAt","effectiveDate","+effectiveDate","-effectiveDate","displayDate","+displayDate","-displayDate"],"type":"string"},"type":"array"},"id":"schema_5816"},"schema_5817":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PastTransactionResponse"}},"type":"object"}]},"id":"schema_5817"},"schema_5818":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/LoanSchedule"},{"$ref":"#/components/schemas/DueDateDeferralFeeAmount"},{"$ref":"#/components/schemas/DeltaTerms","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If deferred due date is in the past, this will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise will be present."},"children":[]}]}]}]},{"properties":{"isLocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the loan is in the middle of being updated or replayed. The returned data are not consistent. The caller should poll"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get loan lock status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isLocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the caller should call GET /expected-payments again to get consistent data."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"type":"object"}]},"id":"schema_5818"},"schema_5819":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/LoanSchedule"},{"$ref":"#/components/schemas/DueDateDeferralFeeAmount"},{"$ref":"#/components/schemas/DeltaTerms"}]}},"type":"object"}]},"id":"schema_5819"},"schema_5820":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ExpectedPaymentsResult"},{"$ref":"#/components/schemas/DeltaTerms"}]}},"type":"object"}]},"id":"schema_5820"},"schema_5821":{"kind":"json-schema","data":{"enum":["unfulfilled","overdue"],"type":"string"},"id":"schema_5821"},"schema_5822":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/ObligationsResult"}},"type":"object"}]},"id":"schema_5822"},"schema_5823":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ObligationResult"},{"$ref":"#/components/schemas/IsLocked"}]}},"type":"object"}]},"id":"schema_5823"},"schema_5824":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LOCObligationsResult"}},"type":"object"}]},"id":"schema_5824"},"schema_5825":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/LOCObligationResult"},{"$ref":"#/components/schemas/IsLocked"}]}},"type":"object"}]},"id":"schema_5825"},"schema_5826":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanPeriod"}},"type":"object"}]},"id":"schema_5826"},"schema_5827":{"kind":"json-schema","data":{"enum":["active","inactive","canceled"],"type":"string"},"id":"schema_5827"},"schema_5828":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomPaymentPlanResult"},"type":"array"}},"type":"object"}]},"id":"schema_5828"},"schema_5829":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CustomPaymentPlanResult"}},"type":"object"}]},"id":"schema_5829"},"schema_5830":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ExpectedPaymentsResult"}]}},"type":"object"}]},"id":"schema_5830"},"schema_5831":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PromiseToPayPlan"}},"type":"object"}]},"id":"schema_5831"},"schema_5832":{"kind":"json-schema","data":{"items":{"enum":["scheduled","active","kept","broken","canceled"],"type":"string"},"type":"array"},"id":"schema_5832"},"schema_5833":{"kind":"json-schema","data":{"enum":[true,false],"type":"boolean"},"id":"schema_5833"},"schema_5834":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PromiseToPayPlan"},"type":"array"}},"type":"object"}]},"id":"schema_5834"},"schema_5835":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"items":{"properties":{"apiName":{"$ref":"#/components/schemas/FeeApiName"},"displayName":{"$ref":"#/components/schemas/FeeDisplayName"}},"type":"object"},"type":"array"}},"type":"object"}]},"id":"schema_5835"},"schema_5836":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"loanFeeIds":{"items":{"description":"The identifier of the loan fee","type":"string"},"type":"array"}},"type":"object"},"id":"schema_5836"},"schema_5837":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"feeAmount":{"description":"The updated amount of the draw fee. The new amount cannot be higher than the amount passed on draw creation in atOrigination.\n","type":"number"}},"type":"object"},"id":"schema_5837"},"schema_5838":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanFee"},"type":"array"}},"type":"object"}]},"id":"schema_5838"},"schema_5839":{"kind":"json-schema","data":{"properties":{"apiName":{"$ref":"#/components/schemas/FeeApiName"},"caseId":{"description":"An identifier for an existing case.","type":"string"},"chargeDate":{"$ref":"#/components/schemas/ChargeDate"},"chargeTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value can be provided only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is passed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTimeOfDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Peach system will determine and set the time of day."},"children":[]}]}]}],"type":"object"}]},"customDisplayName":{"description":"A custom description of the fee. If provided, this value will be displayed in Peach UI/App and Statements\n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements\nlogic will use displayName attribute. To remind, the displayName is populated from the fee type configuration object.\n","nullable":true,"type":"string"},"externalId":{"description":"The lender's identifier for the fee.","type":"string"},"feeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee amount, which is required only if the fee type was configured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargedLogic=adHoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountLogic=adHoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In all other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cases, the system will calculate the fee based on pre-configured logic."},"children":[]}]}]}],"type":"number"},"migration":{"$ref":"#/components/schemas/FeesMigrationDetails","nullable":true},"previewMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewMode=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is computed but not charged."},"children":[]}]}]}],"type":"boolean"},"triggerPeriodId":{"description":"The ID of the period that \"triggered\" the fee. For example, if a loan is late by 5 periods, which period is this particular late fee for?\n","type":"string"}},"type":"object"},"id":"schema_5839"},"schema_5840":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanFee"},"type":"array"}},"type":"object"}]},"id":"schema_5840"},"schema_5841":{"kind":"json-schema","data":{"properties":{"message":{"description":"The reason that the fee could not be charged.","type":"string"}},"type":"object"},"id":"schema_5841"},"schema_5842":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"feeAmount":{"description":"The updated amount of the origination fee. The new amount cannot be higher than the amount passed on loan creation in atOrigination.\n","type":"number"}},"type":"object"},"id":"schema_5842"},"schema_5843":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"An identifier for an existing case.","type":"string"},"customDisplayName":{"description":"A custom description of the fee. If provided, this value will be displayed in Peach UI/App and Statements\n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements\nlogic will use displayName attribute. To remind, the displayName is populated from the fee type configuration object.\n","nullable":true,"type":"string"},"externalId":{"description":"The lender's identifier for the fee.","nullable":true,"type":"string"},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated amount of the dynamic fee. Only applies to dynamic fees. Only applicable if dynamic fee type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic.annualAmountCaps.capAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capLogic.annualAmountCaps.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annualPercentageOfCreditLimitCap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]}]}]}],"type":"number"}},"type":"object"},"id":"schema_5843"},"schema_5844":{"kind":"json-schema","data":{"items":{"format":"date","type":"string"},"type":"array"},"id":"schema_5844"},"schema_5845":{"kind":"json-schema","data":{"properties":{"data":{"properties":{"effectiveRates":{"items":{"properties":{"effectiveDate":{"description":"The effective date.","format":"date","type":"string"},"effectiveInterestRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual effective interest rate on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the value is calculated as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate + indexRate - promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestType=absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the value is calculated as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interestRate - promoRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, the value cannot be negative, and cannot be higher than the lowest rate cap for the given date."},"children":[]}]}]}],"format":"float","type":"number"},"indexRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual interest index rate value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]}]}]}],"format":"float","type":"number"},"indexRateId":{"description":"The identifier of the index rate that is effective on this date.\n","nullable":true,"type":"string"},"interestRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual net interest rate on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more interest rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), Peach system selects the lowest rate (also called effective rate) to accrue interest."},"children":[]}]}]}],"format":"float","type":"number"},"interestRateId":{"description":"The identifier of the interest rate that is effective on this date.","type":"string"},"interestType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interest type. The interest type cannot be changed after the loan status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and onward. Interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will calculate an absolute rate by adding the relative loan rate (aka spread) provided here to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest Rate is not set, the system will assume that the Index Interest Rate value is zero on the date the interest is accrued."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interest rates defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use the value as provided here without adding the Index Interest Rate."},"children":[]}]}]}],"enum":["absolute","spread"],"type":"string"},"promoRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The annual promo rate on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more promo rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date (aka overlap), Peach system sums up the rates as \"effective\" promo rate."},"children":[]}]}]}],"format":"float","type":"number"},"promoRateIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifiers of the promo rates that are effective on this date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(If two or more promo rates are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system sums the rates up to an \"effective\" promo rate.)"},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"rateCap":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate cap value that was applied to limit the effective interest rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the actual rate cap value (as a decimal, e.g., 0.36 for 36%)."},"children":[]}]}]}],"format":"float","nullable":true,"type":"number"},"rateCapIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The public identifiers of the rate caps that are in effect on this date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(If two or more rate caps are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same date, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system uses the lowest rate cap.)"},"children":[]}]}]}],"items":{"pattern":"^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$","type":"string"},"type":"array"}},"title":"effective rate","type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"id":"schema_5845"},"schema_5846":{"kind":"json-schema","data":{"properties":{"data":{"properties":{"interestRates":{"items":{"$ref":"#/components/schemas/InterestRateResponse"},"type":"array"},"promoRates":{"items":{"$ref":"#/components/schemas/PromoRate"},"type":"array"}},"type":"object"}},"type":"object"},"id":"schema_5846"},"schema_5847":{"kind":"json-schema","data":{"allOf":[{"properties":{"interestRate":{"allOf":[{"$ref":"#/components/schemas/InterestRate"},{"$ref":"#/components/schemas/isEndExistingRatesFlag"}]},"promoRate":{"allOf":[{"$ref":"#/components/schemas/PromoRate"},{"$ref":"#/components/schemas/isEndExistingRatesFlag"}]}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]},"id":"schema_5847"},"schema_5848":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"ratesValidation":{"$ref":"#/components/schemas/InterestRateValidationAfterOrig"}},"type":"object"}},"type":"object"}]},"id":"schema_5848"},"schema_5849":{"kind":"json-schema","data":{"allOf":[{"properties":{"interestRate":{"$ref":"#/components/schemas/InterestRate"},"promoRate":{"$ref":"#/components/schemas/PromoRate"}},"type":"object"},{"$ref":"#/components/schemas/CaseId"}]},"id":"schema_5849"},"schema_5850":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RateCap"},"type":"array"},"id":"schema_5850"},"schema_5851":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/RateCap"}},"type":"object"}]},"id":"schema_5851"},"schema_5852":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RateCapId"},"id":"schema_5852"},"schema_5853":{"kind":"json-schema","data":{"properties":{"message":{"example":"Rate cap deleted successfully","type":"string"}},"type":"object"},"id":"schema_5853"},"schema_5854":{"kind":"json-schema","data":{"enum":["autoPay","settlement","reversal","downPayment","oneTimePayment","reimbursement"],"type":"string"},"id":"schema_5854"},"schema_5855":{"kind":"json-schema","data":{"items":{"properties":{"achReturnCode":{"description":"The ACH return code indicating the reason the transaction failed.","example":"R01","maxLength":5,"type":"string"},"failureReason":{"$ref":"#/components/schemas/TransactionFailureReason"},"processorFailureDetails":{"description":"The error details returned by the payment processor. Can be any valid JSON object.","example":{"code":"INSUFFICIENT_FUNDS"}},"processorFailureReason":{"description":"The raw failure reason returned by the payment processor.","example":"Insufficient Funds. Retry after 24 hours.","type":"string"},"transactionId":{"description":"ID of the transaction to fail.","type":"string"}},"required":["transactionId","failureReason"],"type":"object"},"type":"array"},"id":"schema_5855"},"schema_5856":{"kind":"json-schema","data":{"properties":{"caseId":{"description":"The identifier of an existing case.","type":"string"},"effectiveDate":{"description":"New effective date for the transaction.","format":"date","type":"string"},"effectiveTimeOfDay":{"allOf":[{"$ref":"#/components/schemas/TimeOfDay"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective time of day on effectiveDate in the product timezone. If the time of day is not provided, the Peach system will set the time of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day based on the following logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If backdated to the loan activation date, the system will set the timestamp to the activation timestamp plus a few seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If backdated to a loan non-activation date, the system will set the timestamp to a few minutes after the loan accrued interest on the effectiveDate."},"children":[]}]}]}]}],"type":"object"}]}},"required":["effectiveDate"],"type":"object"},"id":"schema_5856"},"schema_5857":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionCancelReason"},"id":"schema_5857"},"schema_5858":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Chargeback"},"type":"array"}},"type":"object"},"id":"schema_5858"},"schema_5859":{"kind":"json-schema","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the chargeback. If a value is not provided the system would set the amount to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction. If partial chargeback(s) were processed in the past, the caller must provide the amount, otherwise"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the call would fail. Amount provided must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time of the call."},"children":[]}]}]}],"format":"float","type":"number"},"caseId":{"description":"The identifier of an existing case.","type":"string"},"category":{"description":"The chargeback category as received from the payment processor.","type":"string"},"externalCaseNumber":{"description":"The external case number of the chargeback in the payment processor system.","type":"string"},"externalId":{"description":"The lender's identifer of the chargeback","type":"string"},"reasonCode":{"description":"The reason code as received from the payment processor.","type":"string"},"status":{"$ref":"#/components/schemas/ChargebackStatus"}},"type":"object"},"id":"schema_5859"},"schema_5860":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Chargeback"}},"type":"object"}]},"id":"schema_5860"},"schema_5861":{"kind":"json-schema","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the reversal. For regular transactions, it may be a partial or full reversal; however, the sum of all successful reversals for the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction may not exceed the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, it will default to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For past transactions, only full reversals are supported."},"children":[]}]}]}],"format":"float","type":"number"},"caseId":{"description":"The identifier of an existing case.","type":"string"},"externalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external ID of the reversal transaction. This is separate from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction being reversed in the request parameters."},"children":[]}]}]}],"maxLength":200,"minLength":1,"type":"string"},"scheduledDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled date of the reversal transaction. Can only be set for external transactions. If this value is provided, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to a status other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the system will automatically set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the field is not specified."},"children":[]}]}]}],"format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the reversal transaction, not the original transaction. Status may only be set for external transactions. If a status is not passed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the system will default the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - reversal was scheduled for a future date that has not arrived yet. The reversal has not applied to a loan yet and is not included"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the original transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - reversal was initiated and sent to a payment processor. The reversal is applied to a loan and impacts the original transaction's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This status is used normally for ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - reversal was acknowledged by the payment processor and is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - reversal was completed successfully. This status is only allowed for past transactions that were created as part of line of credit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"migration. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only status that can be passed for past transaction reversals. Regular transaction reversals can only be set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["scheduled","initiated","pending","succeeded"],"type":"string"}},"type":"object"},"id":"schema_5861"},"schema_5862":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProcessingCompleteGeneric"},{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/schemas-Statement"}},"type":"object"}]},"id":"schema_5862"},"schema_5863":{"kind":"json-schema","data":{"pattern":"^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$","type":"string"},"id":"schema_5863"},"schema_5864":{"kind":"json-schema","data":{"properties":{"documentDescriptorId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the document descriptor to be attached to the statement."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can only be updated if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCreateAndSendPDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to false on the loan type configuration,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OR the statement was created via LOC migration ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExternal=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"}},"required":["documentDescriptorId"],"type":"object"},"id":"schema_5864"},"schema_5865":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/schemas-Statement"}},"type":"object"}]},"id":"schema_5865"},"schema_5866":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/StatementDetails"}},"type":"object"}]},"id":"schema_5866"},"schema_5867":{"kind":"json-schema","data":{"default":"canceledByUser","enum":["invalidPaymentMethod","paymentMethodRemoved","tooManyFailedAttempts","loanFrozen","loanAccelerated","loanChargedOff","loanPaidOff","canceledByUser","loanTermsChanged"],"type":"string"},"id":"schema_5867"},"schema_5868":{"kind":"json-schema","data":{"default":["booked","modified"],"items":{"enum":["booked","skipped","canceled","modified","draft","processed"],"type":"string"},"type":"array"},"id":"schema_5868"},"schema_5869":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Autopay"}},"type":"object"}]},"id":"schema_5869"},"schema_5870":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Autopay"},{"$ref":"#/components/schemas/DeltaTerms"}]}},"type":"object"}]},"id":"schema_5870"},"schema_5871":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Balances"}},"type":"object"}]},"id":"schema_5871"},"schema_5872":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/FutureBalances"}},"type":"object"}]},"id":"schema_5872"},"schema_5873":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"deferredInterestAccruedAmount":{"description":"The total deferred interest amount accrued between two dates. If the deferred interest promotion is exercised, the deferred interest \nis not expected to be paid. \n","format":"float","type":"number"},"foregoneInterestCapAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of foregone interest that exceeded the interest cap amount. This is only applicable to installment loans with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalInterestCapAmount=\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set atOrigination."},"children":[]}]}]}],"format":"float","type":"number"},"interestAccruedAmount":{"description":"The total interest amount accrued between two dates.","format":"float","type":"number"},"interestDiscountAmount":{"description":"The amount of the interest discount between two dates resulting from discounts, promotions, or other adjustments.","format":"float","type":"number"},"netInterestAccruedAmount":{"description":"The net interest amount accrued between two dates, including adjustments for discounts and promotions.","format":"float","type":"number"}},"type":"object"}},"type":"object"}]},"id":"schema_5873"},"schema_5874":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"allOf":[{"properties":{"creditReportingDetails":{"items":{"$ref":"#/components/schemas/CreditReportingStatus"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/LoanCreditReportingFields"}]}},"type":"object"}]},"id":"schema_5874"},"schema_5875":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/StartCreditReporting"},{"required":["creditAgencyId","reportingStartDate"]}]},"id":"schema_5875"},"schema_5876":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CreditReportingStatus"}},"type":"object"}]},"id":"schema_5876"},"schema_5877":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/DeleteCreditReporting"},{"required":["deletedReason"]}]},"id":"schema_5877"},"schema_5878":{"kind":"json-schema","data":{"$ref":"#/components/schemas/LoanServicer"},"id":"schema_5878"},"schema_5879":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CollectionAgencyLoanDetailsGet"}},"type":"object"}]},"id":"schema_5879"},"schema_5880":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PromoProgramResult"}},"type":"object"}]},"id":"schema_5880"},"schema_5881":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PromoCancelReason"},"id":"schema_5881"},"schema_5882":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PromoProgramDeleteResult"}},"type":"object"}]},"id":"schema_5882"},"schema_5883":{"kind":"json-schema","data":{"items":{"enum":["pending","active","exercised","canceled"],"type":"string"},"type":"array"},"id":"schema_5883"},"schema_5884":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Card"},"type":"array"}},"type":"object"}]},"id":"schema_5884"},"schema_5885":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Card"}},"type":"object"}]},"id":"schema_5885"},"schema_5886":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CardWithPanAndCvv"}},"type":"object"}]},"id":"schema_5886"},"schema_5887":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanLabel"},"type":"array"}},"type":"object"}]},"id":"schema_5887"},"schema_5888":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/LoanLabel"},{"required":["name"]}]},"id":"schema_5888"},"schema_5889":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanLabel"}},"type":"object"}]},"id":"schema_5889"},"schema_5890":{"kind":"json-schema","data":{"items":{"type":"string"},"maxItems":100,"type":"array"},"id":"schema_5890"},"schema_5891":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanIdsResponse"}},"type":"object"}]},"id":"schema_5891"},"schema_5892":{"kind":"json-schema","data":{"properties":{"caseId":{"type":"string"},"channel":{"$ref":"#/components/schemas/InteractionChannel"},"context":{"type":"object"},"loanId":{"type":"string"},"overrideTemplateId":{"$ref":"#/components/schemas/OverrideTemplateId"},"personId":{"type":"string"},"subject":{"$ref":"#/components/schemas/InteractionSubject"}},"required":["subject","channel","personId"],"type":"object"},"id":"schema_5892"},"schema_5893":{"kind":"json-schema","data":{"properties":{"contentHtml":{"type":"string"},"contentText":{"type":"string"},"subjectLine":{"type":"string"}},"type":"object"},"id":"schema_5893"},"schema_5894":{"kind":"json-schema","data":{"properties":{"contentHtml":{"description":"The content of the email in the HTML format.","type":"string"},"contentPlain":{"description":"The content of the email in the plain text format.","type":"string"},"subjectLine":{"description":"The subject line of the email.","type":"string"}},"type":"object"},"id":"schema_5894"},"schema_5895":{"kind":"json-schema","data":{"allOf":[{"required":["theme","channel","status"]},{"$ref":"#/components/schemas/Interaction"}]},"id":"schema_5895"},"schema_5896":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Interaction"}},"type":"object"}]},"id":"schema_5896"},"schema_5897":{"kind":"json-schema","data":{"default":"html","enum":["text","html","pdf"],"type":"string"},"id":"schema_5897"},"schema_5898":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/TemplateRender"},{"required":["subject","channel","personId"],"type":"object"}]},"id":"schema_5898"},"schema_5899":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/TemplateRender"},{"properties":{"documentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the Document Descriptor. Can be Peach or lender's external identifier. The rendered content will create a file in HTML or text format and associate it with the documentId. To convert the rendered document to PDF please use another endpoint, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"convert_person_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as an extra step."},"children":[]}]}]}],"type":"string"},"statementId":{"description":"The unique identifier of the Statement. Can be Peach or lender's external identifier. The statement attributes will be used as dynamic fields in the template.\n","type":"string"}},"required":["subject","channel","personId","documentId"],"type":"object"}]},"id":"schema_5899"},"schema_5900":{"kind":"json-schema","data":{"properties":{"interactionId":{"description":"The interaction to resend.","type":"string"}},"required":["interactionId"],"type":"object"},"id":"schema_5900"},"schema_5901":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"interactionId":{"description":"ID of the new interaction.","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5901"},"schema_5902":{"kind":"json-schema","data":{"properties":{"message":{"type":"string"}},"type":"object"},"id":"schema_5902"},"schema_5903":{"kind":"json-schema","data":{"additionalProperties":false,"properties":{"channel":{"$ref":"#/components/schemas/InteractionChannel"},"context":{"description":"Template specific properties to substitute in the corresponding\nConfirmationCode template.\n","type":"object"},"email":{"description":"The destination email address.","type":"string"},"personId":{"description":"The borrower's unique identifier. Can be Peach or lender's\nexternal identifier.\n","type":"string"},"phone":{"description":"The destination phone number.","type":"string"}},"required":["personId"],"type":"object"},"id":"schema_5903"},"schema_5904":{"kind":"json-schema","data":{"properties":{"contentHtml":{"description":"The content of the email in the HTML format.","type":"string"},"contentPlain":{"description":"The content of the email in the plain text format.","type":"string"},"isTransactional":{"$ref":"#/components/schemas/SendIsTransactionalDefaultFalse"},"language":{"$ref":"#/components/schemas/language"},"personalizations":{"description":"Specifies the email destination. See the body of POST /mail/send at https://sendgrid.com/docs/api-reference/.\n","items":{},"type":"array"},"previousInteractionId":{"description":"The ID of an existing interaction to link the new interaction to.\n","type":"string"},"subjectLine":{"description":"The subject line of the email.","type":"string"},"theme":{"$ref":"#/components/schemas/InteractionTheme"}},"required":["personalizations"],"type":"object"},"id":"schema_5904"},"schema_5905":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"interactionId":{"description":"ID of the new interaction","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5905"},"schema_5906":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/SubjectDescriptor"},"type":"array"},"id":"schema_5906"},"schema_5907":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InteractionSubject"},"id":"schema_5907"},"schema_5908":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CompanyId"},"id":"schema_5908"},"schema_5909":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TemplateDescriptor"},"type":"array"},"id":"schema_5909"},"schema_5910":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TemplateDescriptorId"},"id":"schema_5910"},"schema_5911":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TemplateVersion"},"type":"array"},"id":"schema_5911"},"schema_5912":{"kind":"json-schema","data":{"items":{},"type":"array"},"id":"schema_5912"},"schema_5913":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TemplateVersionId"},"id":"schema_5913"},"schema_5914":{"kind":"json-schema","data":{"properties":{"context":{"type":"object"},"personId":{"$ref":"#/components/schemas/AnyId"}},"required":["personId"],"type":"object"},"id":"schema_5914"},"schema_5915":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/TemplateRender"},{"required":["personId"],"type":"object"}]},"id":"schema_5915"},"schema_5916":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionSubject"},"type":"array"},"id":"schema_5916"},"schema_5917":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/TemplateVersion"},"type":"array"}},"type":"object"}]},"id":"schema_5917"},"schema_5918":{"kind":"json-schema","data":{"enum":["pending","completed","failed"],"type":"string"},"id":"schema_5918"},"schema_5919":{"kind":"json-schema","data":{"items":{"enum":["borrower","contact","lastTaskMeta"],"type":"string"},"minItems":1,"type":"array"},"id":"schema_5919"},"schema_5920":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InteractionDirection"},"id":"schema_5920"},"schema_5921":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionStatusDetails"},"type":"array"},"id":"schema_5921"},"schema_5922":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionAgentOutcome"},"type":"array"},"id":"schema_5922"},"schema_5923":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InteractionTheme"},"type":"array"},"id":"schema_5923"},"schema_5924":{"kind":"json-schema","data":{"nullable":true,"type":"string"},"id":"schema_5924"},"schema_5925":{"kind":"json-schema","data":{"properties":{"joinType":{"default":"solo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method of joining the conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"solo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only add agent to conversation if there are no other agents in conversations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - simply add agent to conversation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"takeover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - remove all other agents from conversation, the add agent"},"children":[]}]}]}]}],"enum":["solo","add","takeover"],"type":"string"}},"type":"object"},"id":"schema_5925"},"schema_5926":{"kind":"json-schema","data":{"properties":{"url":{"format":"uri","type":"string"}},"type":"object"},"id":"schema_5926"},"schema_5927":{"kind":"json-schema","data":{"allOf":[{"required":["direction","theme","channel","status"]},{"$ref":"#/components/schemas/Interaction"}]},"id":"schema_5927"},"schema_5928":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/InteractionCanInteractResult"}},"type":"object"}]},"id":"schema_5928"},"schema_5929":{"kind":"json-schema","data":{"enum":["draft","active","inactive","archived"],"type":"string"},"id":"schema_5929"},"schema_5930":{"kind":"json-schema","data":{"items":{"enum":["draft","active","inactive","archived"],"type":"string"},"type":"array"},"id":"schema_5930"},"schema_5931":{"kind":"json-schema","data":{"enum":["sameAsCash","deferredInterest"],"type":"string"},"id":"schema_5931"},"schema_5932":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PromoProgramTypeFields"}},"type":"object"}]},"id":"schema_5932"},"schema_5933":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentProcessor"},"type":"array"}},"type":"object"}]},"id":"schema_5933"},"schema_5934":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentProcessor"}},"type":"object"}]},"id":"schema_5934"},"schema_5935":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CardIssuer"},"type":"array"}},"type":"object"}]},"id":"schema_5935"},"schema_5936":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CardIssuer"},{"required":["status","cardIssuerType","cardType"]}]},"id":"schema_5936"},"schema_5937":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CardIssuer"}},"type":"object"}]},"id":"schema_5937"},"schema_5938":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/components/schemas/FundingInstrument"},"type":"array"}},"required":["count","data"],"type":"object"}],"title":"Funding Instruments"},"id":"schema_5938"},"schema_5939":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/FundingInstrument"}},"type":"object"}]},"id":"schema_5939"},"schema_5940":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Employee"},"type":"array"}},"type":"object"}]},"id":"schema_5940"},"schema_5941":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Employee"},{"required":["userId"],"type":"object"}]},"id":"schema_5941"},"schema_5942":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Employee"}},"type":"object"}]},"id":"schema_5942"},"schema_5943":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/EmailSignature"}},"type":"object"}]},"id":"schema_5943"},"schema_5944":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"}},"type":"object"}]},"id":"schema_5944"},"schema_5945":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Team"}},"type":"object"}]},"id":"schema_5945"},"schema_5946":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/User"}},"type":"object"}]},"id":"schema_5946"},"schema_5947":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/components/schemas/Investor"},"type":"array"}},"required":["count","items"],"type":"object"}],"title":"rules"},"id":"schema_5947"},"schema_5948":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"count":{"format":"int32","type":"integer"},"data":{"items":{"$ref":"#/components/schemas/SettlementInstrument"},"type":"array"}},"required":["count","data"],"type":"object"}],"title":"Settlement Instruments"},"id":"schema_5948"},"schema_5949":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/SettlementInstrument"}},"type":"object"}]},"id":"schema_5949"},"schema_5950":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/TapeType"},"type":"array"}},"type":"object"}]},"id":"schema_5950"},"schema_5951":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/TapeType"},{"required":["tapeType","tapeName","fields"]}]},"id":"schema_5951"},"schema_5952":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/TapeType"}},"type":"object"}]},"id":"schema_5952"},"schema_5953":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanTape"},"type":"array"}},"type":"object"}]},"id":"schema_5953"},"schema_5954":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/LoanTape"},{"required":["loanTapeTypeId","sftpHostname"]}]},"id":"schema_5954"},"schema_5955":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/LoanTape"}},"type":"object"}]},"id":"schema_5955"},"schema_5956":{"kind":"json-schema","data":{"properties":{"forceReplace":{"default":false,"description":"Creates another Loan Tape Record even if one already exists","type":"boolean"},"loanTapeIds":{"description":"The loan tape public IDs to generate for. If not provided, we will look up\nall IDs for the company.\n","items":{"type":"string"},"nullable":true,"type":"array"},"reportDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dates to use for loan tape. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2020-02-01"},"children":[]}]}]}],"items":{"format":"date","type":"string"},"type":"array"},"uploadFile":{"default":true,"type":"boolean"}},"type":"object"},"id":"schema_5956"},"schema_5957":{"kind":"json-schema","data":{"allOf":[{"properties":{"data":{"items":{"properties":{"loanTapeId":{"type":"string"},"operationId":{"type":"string"},"reportDate":{"format":"date","type":"string"}},"type":"object"},"type":"array"},"status":{"type":"integer"}},"type":"object"}]},"id":"schema_5957"},"schema_5958":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LoanTapeRecord"},"type":"array"}},"type":"object"}]},"id":"schema_5958"},"schema_5959":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"$ref":"#/components/schemas/Merchant"}},"type":"object"}]},"id":"schema_5959"},"schema_5960":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Merchant"},{"required":["businessName"]}]},"id":"schema_5960"},"schema_5961":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/Merchant"}},"type":"object"}]},"id":"schema_5961"},"schema_5962":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NewPaginator"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/EventPublic"},"type":"array"}},"type":"object"}]},"id":"schema_5962"},"schema_5963":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookSubscription"},"type":"array"}},"type":"object"}]},"id":"schema_5963"},"schema_5964":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/WebhookSubscription"},{"required":["webhookType"]}]},"id":"schema_5964"},"schema_5965":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}},"type":"object"}]},"id":"schema_5965"},"schema_5966":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/AmortizationResult"}},"type":"object"}]},"id":"schema_5966"},"schema_5967":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/AmortizationCombinationsResult"}},"type":"object"}]},"id":"schema_5967"},"schema_5968":{"kind":"json-schema","data":{"pattern":"\\d{9}","type":"string"},"id":"schema_5968"},"schema_5969":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"bankName":{"description":"The financial institution name.","example":"PEACH BANK AND TRUST","type":"string"},"lastUpdatedDate":{"description":"Peach system receives a list of valid routing numbers published by the Federal Reserve Bank once or twice a month.\nThis is the date when Peach received the latest update.\n","type":"string"},"routingNumber":{"description":"The routing number. If the institution has received a new routing number from The Fed,\nthis may differ from the input routing number. Otherwise, it will match to the input routing number.\n","example":12345678,"type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5969"},"schema_5970":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"lastUpdatedDate":{"description":"Peach system receives a list of valid routing numbers published by the Federal Reserve Bank once or twice a month.\nThis is the date when Peach received the latest update.\n","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5970"},"schema_5971":{"kind":"json-schema","data":{"properties":{"cardNumber":{"description":"The card number. Must provide at least first 4 digits of the card number.","example":"4111111111111111","pattern":"^\\d{4,}$","type":"string"}},"type":"object"},"id":"schema_5971"},"schema_5972":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"cardNetwork":{"description":"The card network.","enum":["visa","mastercard","discover","americanexpress"],"example":"visa","nullable":true,"type":"string"},"cardType":{"description":"The card type.","enum":["credit","debit"],"example":"debit","type":"string"},"issuer":{"description":"The card issuer institution name.","example":"First United Bank","type":"string"},"lastUpdatedDate":{"description":"Peach system receives a BIN list published by First Data/Fiserv a few times per month.\nThis is the date when Peach received the latest update.\n","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5972"},"schema_5973":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"properties":{"lastUpdatedDate":{"description":"Peach system receives a BIN list published by First Data/Fiserv a few times per month.\nThis is the date when Peach received the latest update.\n","type":"string"}},"type":"object"}},"type":"object"}]},"id":"schema_5973"},"schema_5974":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/IndexRateResult"}},"type":"object"}]},"id":"schema_5974"},"schema_5975":{"kind":"json-schema","data":{"maxLength":32,"minLength":32,"type":"string"},"id":"schema_5975"},"schema_5976":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CreditAgency"},"type":"array"}},"type":"object"}]},"id":"schema_5976"},"schema_5977":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreditAgency"},{"required":["agencyName","country","dataFormat"]},{"properties":{"copyKeysFrom":{"$ref":"#/components/schemas/AnyId","description":"The identifier of the agency to copy keys from."},"enrollExistingLoans":{"default":false,"description":"Automatically enroll existing active loans for credit reporting with this agency.","type":"boolean"}},"type":"object"}]},"id":"schema_5977"},"schema_5978":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CreditAgency"}},"type":"object"}]},"id":"schema_5978"},"schema_5979":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Paging"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CollectionAgency"},"type":"array"}},"type":"object"}]},"id":"schema_5979"},"schema_5980":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CollectionAgencyPost"},{"required":["legalName","contactPhone","mailingAddress"]}]},"id":"schema_5980"},"schema_5981":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SingletonResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CollectionAgency"}},"type":"object"}]},"id":"schema_5981"}},"exampleStore":{},"securitySchemeStore":{"apiKeyHeader":{"id":"apiKeyHeader","type":"apiKey","in":"header","paramName":"X-API-KEY"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},"bearerAuthQuery":{"id":"bearerAuthQuery","type":"apiKey","in":"query","paramName":"token"},"oauth2":{"id":"oauth2","type":"oauth2","flows":{}}},"servers":[{"url":"https://sandboxapi.peach.finance/api"}],"logo":{"imageUrl":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA1wAAAE0CAYAAAA43TLaAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAC+FSURBVHgB7d3PbltXtufxtQ/txHYKKPaggZukgZBxzU0Pbl2nJ6GewMrgom13AMtPYEqpeaR5ItFPYBpI20bXIPITmJl0OVWDMPNyeAJcJwXcwWUBlVhJmWf13iTlP7L+i/ucffb5fgDHf2NLlESe31lrr2UkQsPOx+3MjBfdj5NabbP52Rd9AQAAAICcGYnM45VrS0b09o5fTlWSW0k23mx276cCAAAAADmILnB9t3J1aL9r7PkHVPpqzJ0ky/qELwAAAAA+xRi49Ah/fFPFPDi/frcnAAAAADBnVQ9c21Ijpi9JcofzXgAAAADmhcD1ulRVHiSqXVoOAQAAAJwEgWs/Rgaq5hbnvQAAAAAcB4HrsJ4P2/h5s9ndHAkAAAAAHIDAdWRmZB+0Tc57AQAAADgIgetkpsM2MrnV7N4dCAAAAAC8hMA1PyxXBgAAAPAKApcPLFcGAAAAIASuPGxmRu787vN7mwIAAACgUghc+WG5MgAAAFAxBK5isFwZAAAAqAACV9FYrgwAAABEi8AVktmwjfPrd3sCAAAAoPQIXEFiuTIAAAAQAwJX+FiuDAAAAJQUgatcWK4MAAAAlAiBq6w47wUAAAAEj8BVckZMT7Kfl5vdzZEAAAAACMopQamp6JIm59wPbwgAAACAoCSC0jM2dA3/8HFbAAAAAASFwBWLLLsuAAAAAIJC4IqEirYFAAAAQFAIXAAAAADgCYELAAAAADwhcAEAAACAJwQuAAAAAPCEwAUAAAAAnhC4AAAAAMATAhcAAAAAeELgAgAAAABPCFwAAAAA4AmBCwAAAAA8IXABAAAAgCcELgAAAADwhMAFAAAAAJ4QuAAAAADAEwIXAAAAAHgSYeAyIwEAAACAAEQXuIzRgQAAAABAAOKrcI11TQAAAAAgANEFrmb3fl+F0AUAAACgeFEOzTi/fn+V0AUAAACgaNFOKXShy2TatMHrhqhwrgsAAABA7oxUxLBzpaHGrNr3+EP704bEJ31//V5TAAAAAASjMoHrZTZ8tW34WhJjLotoXeJA4AIAAAACU8nA9bLHK1eWEkkuq+iilBuBCwAAAAhM5QPXNtdymCXSToy5riptKR8CFwAAABAYAtcuJuHLmI4xclnKc96LwAUAAAAEhsB1gBfnvYIftkHgAgAAAAJD4DqCYefqohpZtI/adQkPgQsAAAAIDIHrGAI970XgAgAAAAJD4DqhSfgSs2gSuSnFthwSuAAAAIDAELjmaNi51lKjnYLOexG4AAAAgMAQuDx5adhGXue9CFwAAABAYAhcng07i/UsObOYw3kvAhcAAAAQGAJXjraHbRgxn8r8Ww4JXAAAAEBgCFwF8XDei8AFAAAABIbAFYA5nfcicAEAAACBIXAF5ITnvQhcAAAAQGAIXIE68n4vNYP3N+5eFAAAAADBIHCVwEsth3ue9zJies31uzcEAAAAQDAIXCUz7FxdlMRcV9HF57+okhrVhWb3fioAAAAAgkHgKinXcmg/fK3pz572m93NkQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIlhEEZdhZrIuca4xr2jBq7I/dN60nIu+531f7Y/uf+qH+MiMjI2aUqf5djBnZX0nV6KhmaiN59ixtdu+nAgAAAMAbAlcBtkNVlkhLVFvGTMJUaztcSZ6MDCSTkYp8a0PZIEmSVJ79Y9Dsbo4EAAAAwIkQuDybhqvftLJEW4noBVuhattfbkjobBCzFbZBJubbJNN+s3t3IAAAAACOhMA1Z88Dlhkv2gf3gq0atXKvWnnhWhK1r5J8RQADAAAADofANQfDzpVGltQWjWaX4wlYB0qNmL4kyZ3mZ1/0BQAAAMBrCFzHNOx83JYk+1BFl6QMLYJemZH9RNocG33wu8/vbQoAAACACQLXEQw711qSyGVC1r6ofAEAAAAzBK4DuDNZWfLW0rRdUNqCo0hVzFqSZX1G0AMAAKCKCFx7cC2Dk8EXxlyvyJksj6Yth5JlawQvAAAAVAmBawcXtNSMP6Wa5YcR06PdEAAAAFVB4JLZKPfk3E3OZuVIpW9qtTWCFwAAAGJW6cD1ImhJh7bBghC8AAAAELFKBi6CVngmrYac8QIAAEBkKhe4Hq9cWzKinwqtg0EieAEAACAmlQlcDMMolck4+fPrd3sCAAAAlFj0gcu1D47N2W5i5LqgbFKT6QLVLgAAAJRVIhEbfnLtpibnhoSt0mpoYobDlWufCgAAAFBCUVa4hp1rLTW6QftgVKh2AQAAoHSiq3C5aogm+g1hKzpUuwAAAFA60VS4hp0rjSyRTSPmgiB2VLsAAABQClFUuKZntZJvCFuV4apdD92IfwEAAAACVuoK12yB8W0VXRRUkg3Zq831u2sCAAAABKi0gWsyGCPRL4UFxlDpG9UbtBgCAAAgNKVsKZy2EMpDIWzBMdJ2LYbuHJ8AAAAAASldhWu4cnVDRToCvC412bOPmt0/DgQAAAAIQGkClzuvpebsl4x7x0FsIF8+v36vKwAAAEDBShG4XKuYaxkTWghxSAzTAAAAQAiCP8M1HY5B2MLRqOgqS5IBAABQtKAD118/ubrIcAwcF6ELAAAARQu2pfD7T65eH6v0BDgh2gsBAABQlCArXG7sO2EL80KlCwAAAEUJLnANV658qqpMmMNcEboAAABQhKBaCidhS8yqAJ7QXggAAIA8BRO4CFvIS01l6b2Ne3cEAAAA8CyIwMWADOTNJLWF5mdf9AUAAADwqPDA5Ua/JypfCpCvkcn0YrN7PxUAAADAk0ID17BzpaFJ8o2I1gXIX2qypzZ0bY4EAAAA8KCwKYXTsGUeErZQoIaas1RXAQAA4E0hFa5hZ7GuyVlb2ZKG4DBSI2aQqX4vKqkkZpRkWbr9e7v8+cb0O1PPEuMCbcMm6/fEaEPVtAi5rzKSdJvr/2dZAAAAgDkrJnCtXN1QkY7gdSoD+9h8JcYMbKjq+zhj5AKvyJlWliRtG8Qu2H+vXfUQlhn56Hef39sUAAAAYI5yD1yMf9/JjFT1TqLSF3naL+o80bBzrZWJtpOaXFZ1AaxyGKIBAACAucs1cA07H7c1GT+UytsOWbppL/D7Ehh3vi5LpJ0Yc71S4cuG3vc37i0IAAAAMCe5Ba4XQzIqfG7LXtAb1bUQQ9ZeZuFryYi5LhX42HGeCwAAAPOUW+D6bvnqQ/uvtaVybDVLsltJttUt+/jxxytXlqpQ9WIpMgAAAOYll8BVzXNb8QStnWzVqy0182nEwYv9XAAAAJgL74Fr1ko4lMqIN2jt5IKXGrNhP4taEhlaCwEAADAPXgNX1fZtGTGbkmXLVZt051oN7fv+qUT2caa1EAAAACeViE/J2eguwnelrgVNF5rrdz+q4ljx8+v3e++v32uq6JpERMfjTwUAAAA4AW8VrqqMgFeVW4k+XeW8z1Rs0yhVZPn8+r2uAAAAAMfgJXBVopXQVbVUb5RpxHueHq9cWZ21GZbdyGRPmwRqAAAAHIeflsLYWwkn+7TcFDvC1l7Or99fNZm5aH+YSrnVJXmL1kIAAAAcy9wrXLFPJVQxa+fX764KDsV9PkjN3C77CHmTPbMB+48DAQAAAI5g7hWu2fmdCJlRZsYfEbaOxg0RaX5+b6HsAzXUnNoQAAAA4IjmGrger1xbkhhbCSdTCGXhd5//303BsbgWw1KHLiPt4R8+bgsAAABwBHMLXK51zIjGd9ZlOhxjodm9SzvZCU3PdekNKSnGxAMAAOCo5lfhSsxNia269TxsVW+3li/2seyVNnRR5QIAAMARzSVwTQZliHQkJoQtb2aha0FKiCoXAAAAjmIuUwr/uny1lxi5LrEgbOXCBvUlTcxtKRmT1Baan33RFwAAMHeN1qWG+/7ZrHNqLKaeiNbdj81L62ZO2R+P5MxoNOizKxNBO3Hgim4MPGErV6UMXSr99zfulbJCBwBACOqtdv0t+akhkrTtN9cp9Z59gW3JsY+nmIERtcHLfCuSpcb+/B9yZkAYQwhOHrhWrn2poosSBTMyWXaRsJWvxytXVu0TY6la9ahyHezd1qWHGvMC9NfY54/Ji/1Ean/+d/vcOFL7op/Is/TJ4C9RDt75F3snOhGJdB1I/uzn0K0ng6+7AnmndcndzG2INzr6YfD1fxPkwgWs38hWyz4n2mtGvWBfH9qSCxfE5KtMpP9U3uxXIYDZrx03VfuCeGIfy4W/DR6lUmKz5xcvXBX2yeDRKzfmT8kJ2OpEO56w5ZbbZh8RtvLnphf+dflqo0xtqdl47D7v+4I9zcJWQypD3fv8ys8dM/n1mntydz+zoUsnL/5j+/lT9heslzQEc2EvRusCd8Nmyf8NG1N/u/X7xR8Hf2bliycvQpZcV3m6mE0+v1Xype7fb9nn3ZvnZEveal3q21+8E9lz8Cvs+/rbat3wPJaGeLLbZ/jJhmbUylWV2I99kVuzYasvKERN3+zYD0JpKgDGhsNhZ5ELIxzRpF3GXUjetk++Q3eH7d3WB913W//aEgDP2a+RXK4vEkluCubuf7Qutd1z2zl5OrTVENftsCSB3ExwlbWXnoNvu7dVAM+OHbgmZ7c0r3KwX0ZM7/z63VVBYZrd3siofuTasqQc6llyLq7JnChCw9a/btoK2DfvtD74xt3VF6DiZhfADcmBu/jmgnt+pkHr0sNpyNKboYSsfSy5t3V684vnX/hz7MA1NmZVYqCSSvbzsqBwrp2zTDu6bJXrsgBzM2l7uc0LP6our+pWUf9ejF4NWqW8Gd/g+Rc+HStwuepWLGPgpxMJN5lgE4hm996mrZzekjJQbbEIGR7wwo/KckNY8r5gd/+eO2skOLIIgtZOPP/Ci2MFrliqW7NzW6kgKIm+uSov7dkI2Wx4BuDD9gv/7X+Z7aQBYmdEVqUA52SLFvEjcAH13dYHGxEFrZ0mz78uTPL8i3k4cuCKprqlknJuK0yT81wlaS1keAZysOTGrvOij9i5z3EbuAq6vtCbVLkOx1W1bED9RkWjD6kuTM6Ga9B2ihM5cuDKkqQtEXCthIJguYmRJWktrMup3zBhDr41EtFv3m59QEUV0apN9jMVxdSpch1su6ol1Rs5vvpO64MvufGF4zpy4DKipU/5biohrYThm7YWlmBqYZZFcZ4RoTN1+/z75butS3y+IUrTqXaF4mtrDy5oTJfZx1/V2psu0m2A4zpS4HKLjqXsdzUmUwmzNUHwXGuhShZ8lcst/6atEHlRkR5jrBGb2YCChhSrwdfW69yewCTes1pHRbcBjuVIgWtszJKUnKoyKKNEzq/fX5XwB2jQVohcZbbSxV1WxCSU0eyMiH+VC6AqSRVbCPcx7TZ4u/VvtKDi0A4duKIYluEGZXTv9wSlYitIwVckmVaIfJm6u+PMIX/EIM9FxwdhEfILrn15el4r+OXFhTBiNhimgcM6dOCKYViGq24JSsdWuXrGSF8CZiLZS4dSaZyVp7zYo/TsRX1QlYKMs1yTsOXalwUHWeVcLQ7j0IHLmMIPs54M1a1Sy1TvSNjqw86/01aIXNk7rB3uxqPMZq2xlyUsS1WuHrvzSYStw+NcLQ7jUIHLtRPaz6hSX0xS3So3V+UKfWJhlpxqC5AzzpygzIpadHyQqo6In+5Cy24LjoRztTjIoQJXlphyn0+x1a1EtjYFpRb6xEKjwd2lRQVw5gRlVeyi44NUbxGy+3gknNk6Js7VYn+HClxlP59ijOk3u5vh73PCvpLsTDfoKpcpdxUY5UWVC2VUC3rMuKmfladLUiH2gtDdmG4IjotztdjTgYErhnZC9m7Fwe3lMkYHEi7OcaEQrsrFnVWUTeg3CsKtvs3fbNreBcGJcK4Wezl10B9w7YRGSkylz96teGRq7hjRtgRqdo4r5FCISLkzJ6NAz8PMQSoVYZ/fKtGN4RYda/DVFNNyF8//MXjUl4hNl/jqqmAuMpHb9gbYxdGgT2cVnjswcCVGLqtKaWn40+1wBEn2xqYmv27Yj2yQd/MTMdwhzIm9EdSXIJi6StYo/tyDujOEqxKf9IfBo6YgMubmpMYVuFkVri+Rmp6j0w0Jho5slWhgH/evzORGy3hwWmqjdPAofflPuYr+W/KTfdtr9vlXW/bVt2H/3wsaRptqI/IbYDiGfQPXsLNUV/2lLSWWRPxEWUWurXD4ydWBvQnQlgBpwNW3yKRPBo8WJCDuAuA3stXKpi/4rhWpIbkyLXfx9LcdFyZAaFzVKJtcJIdveyhNrFWu2ZTIhhTKhazEda9s/sfg6/5h/g9XPRq96CZ5/v9Mg9iWG/R2vdjwpTft83GP52Ns2/cM17hW7rBFO2GcMpUHEq7GsLPIWZoKchcA7qLMVmNWXUXGPrm6QJhKjsIeQgBMjUWWpERUSj6peQ/FT4mctM+u/Sxnm08Gf+rMI9S652F7M67nbsjZm19NG7oK6nKaTC1kgAae239oRialfpJRE/SFOY4pyTTwEf+nG4LKm4Uv1wqX29Aee3HxoQABC3sU/O5UsusxDqWZjoAvwoug5W5Q+Trr5KpLPw4eLbng5doUJX9LDNDAtn0DV2LK/eKdZM/6gujMqpapBCpLTjOpEM+5CwrJLXSVo00L1RXqouP9mXpsi5Dd0BIpppXw20zMRZ9BaycXvGwF7aINXcuS81CabHJWEdgncE3GwZd5H4NK2uz+kWlxsVL5SkKlXPTiVe7iIqchHw0BAjUb0FDSBfFxLUIuYiS/DTy3fpYz7aLONdnQ1XVhT3K9YauLrOyAs2fgGtdMqS8a3bJjQbTUhDt63V5QNATYweRS5TJ1d1ErQICmZwyLnuZ5XGZ7GEPpFVTdWnPntIoele7C3huydTHPFsPYqqM4nr1bCkt+fivLsnArIDixoNtFDaPh8Tp3piuPKtdYxtxNRZD8VlXc2V7v7WKxLELO+/1Ym7VWByEdDEbTFsO8BmoobYXYO3AlSbk3jicypp0wYtN2URPqUkEueLEH86149obUaGlFcHxXVf4p2ZobLS4ebY+IlxJzb3/O49KDClsvezJ4tJRPq7epMzwDuwYut3/LPrOU+UV7xPmtCjCaSpjqszOQwCsyGfcFqCZvVRV30fyfg7+4m3A98UxLPuo735H8uhlq2Np2WrY+khzOdGWs7Ki8PSpcW+W+Q6rhnu/BHGXivVpwfLR14XWJnEoFqJgcqiqTytaTwf8b+K5YuPejrOckG61WPcehJWk2mQoYNtdeaC+Eb4h3ZR0Wg3nZNXBlSekHZqSC6IU8OGMspxoC7DCWzHsbrDKpEIHxXFVJ3aLb7Z/kMZwmKdni5m3/lDOLeQ0tcSGmqGmERzU9X2tuiVemxbTCaju12y+qSssYKa1MNODKB+bHneFSCZFJyjqJCwDmx/ei450By108v9u61PdbUZuMiO8WPXHvqOxjktcwtJ77OEiJuAmKjdalrnj0s6DKdg1ctUTe0zCvYw9Fs3CX4mJ+kuyfA01OSaAaAuxQk6SurpvfI815sSewH9+Ljse7thDqA/svt8Wb6SLkUfmWOOfS1pbltuh9vtKSVORQTru2FKqWu6WwdqrGBUclBPxxVqXChdcYybx/XiThTu9ExUzPDMmH4k9vt7a10/JLz/+I+HKN+s5xSl6vLK2EQJ5eC1zDzr/bsFXyi8Vnz1JB9Jrd+6kEKjHmtwLskMekqiyHc2LAYUzPDPmr9u9VSXGDEMT/mZxSjfpWMbm0E5a1ugX4tkuFq1b6O/MhX4hj7lIBSsKI8d7SU5OEwIUgeB6h/mC/SsobsuX1PI5TshHxPiuN26huAXt47QCMm1BY4nkZQBBUtSHAS9zd8EzUe7v2LzKOLHBpfbY0tyLGgyeTnVLl5j5mPidm2rvF+wYqV+V6p3XpgXg8t7S9CDn0ARGutfPXHJ57ktl4fgCve33igNonyHInrlRQGcZIqsqACoQvE7ktOfjPCC7WX2XqmtNjF4aaa8mK4WPobTKhlR4m5LhQlnkeFJGJcWe5+hKwZ3Imj3P5adkmEwJ5ei1wqWjDlDxxAUBI7J1213rUEO+Upe8o3Lut/9lSydriyWF3beU0In7R7VcKeUS8Tqpb3q/r+oLKsDczhvZ1TXB4r53hqiUc9geAeZmFrVXJhflegIJlknXEn1cWHR/Evi2eh2eIuBHxErSkIZ7RTgjs77XARXsWAJycO9th764/lBx39dh72JsCFMj3omM5YiXlx8GfN/MYEe+qXBIsvSCe/UPOUF0H9rHb1tiGAACOzF10vSVbbvzy9TxGwO/0q4y56EGhfC86Pt7Y8cmIeI8TBU39rDxdGh0wyKMo6v26Tgcht1QCIXglcA07S3WVXwQAwqb1d1qXViUAxl5s2bfnt9NzIlsNlcKk8Q3MQNkUsej4IG5E/K/y5k2ZfK36YabDM4IMXOI9cNHKDBxkR4Xrp8buRa9SKf0eMQAHmVw4BbEDR6XAiPWqvgAFymEU/LHOCbkR8e+2Prhjv1Zvij+NEEfEuxZP8Y8bPcABdpzhKv/SYyFwVQpnDoGp47VaAfPjdxGwDk4SZoyo9/ONIS5Crkni/ZpIJSNwAQdIJELDziKhqzJMkB9rY0wqQE6MrW4dp9UKmJe3W793Zxcb4omZnsM6NhfWjOcq8PYiZAmIkcz7a6QNdZzfAg7wSuDKEv+jQ/NxhsBVGcrHGmAkMwqWSOKzXe9Io+D3YnKoAmd+JzQG6RcZE7iAA+yocMVx8ToWk8dWdRRs2Pn3YD/O9kWXQ8TIy1wuRoHjcueEfC4XnldQmrUkpuLVdBGyBGKcS4WrRuACDrAjcIXZnnVUJonj/cBBQj5zqLwAIRcqZlmAAvkeBT+eYyugEfW8CNnUQ1qEnORwhgvAwaI8wyWqVLgqIEtCrmQaAhfy0Ptx8CeWHaMwOSw67s3zfOJp+aXHImQAeXs1cGkcLYX2DlZDEL+AJxQmSZIK4FfKZEIUrTbdP+XNvD/H3Yh4OeEAjoNNFyFLADLJuPkHBOCVwGViGaluzAVB9JJEwv04P/uFFzl4ZWT8EZMJUTQVXRRPfE3fdIuQxbNEzGUJQB4TBMcyppoHHCDOlkKRBqPh46cabkths/tH9pLAG3uRu/xk8Bc+x1Aot+hYPI6Ct9UZL5UoV+Wq4oh4X06JaQiAfcUauOwdl7NtQbSmEwqDbYGlugWf1n4cfO39Dj1wEM+LftMfB3/2dj4xjxHxISxCfuZ9KiODOYDDiDZwGeNvRC2KlyWnwx2YoULlAb6s/TB4tCpAwWbVm4Z44jsQ5bUI+b+3/rXQ16ozspXDDUBW8QAHiTdwScDne3BiqtqWQBljUgHmSl0L1A3CFkLhu7r1k5zJY/qm94Xhb8ipJSnQdEiI36mMyqAy4ECnJFa2wuXOcTW7m7R3RSgx8qEEKhP9VoD5SY1kH1X4zFYqOVwYhyLxXHWZB9+Ljq3+aND3/tp9WrY2f5U3N3zuIFXJrtdb7dU83p+9TdaUeGz702Bfj4FQxBu4nFO/cWXuviAqw84V92LfkEAlSY2WQsyFEXPrJ3mz4Iu1YtnKXvqEyl5QfC86zmvdgav+vNO65AZzeKzWTRchjzw/ZgdwNwEb4o2puxDO1FRgb1EHrmw8duNq+4KoZIlZNBKwZ89SAU5gerZkzCRCBKdsi44P4kbE2yrXTZ9VLrcIWQoMXPbGTaquCdTrvzFZD8Awn+pIpfwakqNXApcakxrPX5R5MmbyotARRCUxclnD/TQdNbv3UwGOwQUtNyzAHegXIEA1MYs+L96TnNtHXZXr3dYHd3Qaijwx9bdbv1/0OXVxf+r9xs1s7xiBqyJ+GDxqSom5G0f2uWYoOYp2aMZMffiHj9uCaEzaCTXgCZRMKMTRpfbb2s9y5r89GTxaIGwhZH6DiaRFfP7bG83eg1Aiic/HbV/jHDp93Jm+eqvNeHhgD3Gf4RLaCmOTJUk75CqsrRJ/JcC+3MRBM7CfxV+5AQkELJSFW3Ts+fxs453Wpdyf4DPxb3sRchFf765F853Wv438tk2KnJWnSyOqXMCudgauVCLj2gqHncVVphXGwYatwhdJ7idJkr4AL6SuncdI8r29rLM/zvo/yVtplYdgoLxCWORbZrPHry+FmNwMvCwe0VYI7C36CpdVz5KzS8KTQOkNO1faIU8nnHj2D1oKc2EGieiyBEZlPDottdFIzowIVYiJq85koT//Bm677a6I5wZ7s7Kv00DkTZFVPCB0O4Zm6MjEMzPjOfs+cdclAmNjloI+dKhmQCU1H/biYcSLOpCfjAFUc1HUiPixmE37+rkhnhVbxQPC9cr1a20c6ThrtwSZ4Rml5oZlJMbrKOITU1HObwGIjpvoJZ7b0apDbxYxXGI2aj8Vz1yV6+3WB4sC4BU7Wgpr0d6d1/GYuy4lZqtbq6GP1ExqtYJG/gKAP6bYpb2RKXQRshu57/0cnhHdsKGyX6a2andToeb5sRmLrLEcurp2BK4z9ovjF4nSrMrV/OyLvqBUJqPgjXwooeP8FoDI5LDouIrc47kqOXNTUbN8Bp80zsrTT+0FZXDnbPdiw9ZtV50Tj7bkTGkeD8zfK0WDZrfnxobGXuVC2SSTF6eGhEylz/ktALGpScB7D8ur4YZLSM7cuVeTU6ePEdMpS2vhO61Ln6r3z3MdMEip2l7v0jKaSqw4y1U6k+qWmCUJnKreEQCIDKPg/SjucdUHkhMj2e3Z+b9gzd6+VfHMSMIZ74p7LXBlmX4vEaPKVS7u7JaUYBRxwvlAAJFxi46FUfBebI9Ql5ydll96bvm65MLU7Wvjw1BDlxte4t4+yYER5Yx3xb0WuGwZOJWYUeUqjTJMJpyYjIO/nwoARMXcFHiTFXA2Lh0M3NGRW5KfRoihy4Wtc7LVl3xuKKSsMcEuLYX+x4YWTbPx7WFnMfexrDiiJPG+M2Qe1NBOCCAurvqioi2BT0tFjIh/Q7a6+VW5JoIKXe7tsGHrG/vDC5KPvqDyXgtcWoHAJe6ORvIWrYUBe7xybcm+2JfiwG2S0SoAIC5jGwYE3rkR8ZKzAqpcjg1d+s2sTbUw7kaCezskx1ZZW8lcE1Tea4GrNtZKjLZWyTq0FobJtRIa0XIE4sl0QtoJAcSDUfB5KmYRcgFVLnFnulTk9jutS7kP03CP8dutS71scmbL5Pl499i9Bee1wDW9eIx3NPzLVMcbtBaGpyyDMhymEwKIDYuO82TqZ+XpkuSsoCrXtiXXYvh269+8V/dc0HJj38/J02ERNxGobmFbstsvGlONKpetTrRoLQzL8JNrN0sxKGMmkS3aCQFEY1rd0suC3BRVTfxh8GjVfpdKMeznmdmwYWj4buuDjXlXvFzroP17uy5oyeQGgini5jrVLTx3ardfzDL51phqLDuctRY+aH72RV9QqMnOLS3PnVX7YtFj2THgl9oLs6LPfeRrPHgy+EthNz3domMt5uK0wkzLBYQiJtnZu+43spxGo++hoaId+3Z07Nd5f7onLOsf9WugYQPbP6fLiz9057/t+1SfPHu4OFuMlOoWXrZr4LIlrsH0E7UaNBt/aS/2L3IWpziutVMTY5/0tTwv9ElCOyHgX8Od+5DKqLmLtMICF4uOizF73PuSMxfybCXolg0pha8A0ElgMm0X+23ly/6KuxaV1Eam73XHeTMzuSmgv7U3B1o2oDV+nQSsF79bNPv23vrb4OtUgJldA1eSZX178SsVUteasaFrcYGKRUGSc/aCShtSFm73FlVRABFxlURl0XEhthchF1HlOi1PV3+VM66NtCFBmawlaO12+1+fFwUKrWLtyr41/R8GX3cFeMmugctVer5buTYqVbXhpFRaWXLO7X26IcjVcOXKp2UZAb9NNSvqsDEA+OL7LFEqpeWuh/y2WtpqjXsd7EvO3ACNf2ldWpiOS6ed9ITSMdeR2MWpvX7DDc5QrcY5rm1GdGm4ci1trt+l7zYn07A1mUpYHirp+e79ngBAJFx1JRN/r/nurv+TwaMFKalGq1W3VaD/Eo9Usuv1Vnt1NOjn3mnjhjvYCudytdp3589ezyz/bfCnVIAdkr1+I1N5IBVkKy2rNnTRw56D7z+5er10YUsmo+AJ5ACi4nvRcSbl7gpwVSDjvfpk6kUsQt5mA3FPGPRwEms/Dv7E5GLsas/AlWQVGQ2/C0KXfy5sjVV6Uja2upUU0PIBAL7ksOg4/XHw59JfiJpcwkgxi5C3uVHxprj9XGW2NhuzD+xqz8DV7N7vV2UB8m4IXf6UNmyJm5Vh7jDNEkBMfC86NpFUTdxAizyqXG/JVqFnmp8M/tSx7ydTeA9J7WNF2MJBkv1+szILkPdA6Jq/MoetSXUry3oCAJFwZ5PsxfWH4k/6k5yJqc0qjyBSyCLklz0ZPFoidB3Mha0f7WMlwAH2DVxVPcf1MkLX/LgBGaUNW0J1C0B8/ilnXDWlIf70ixgC4ctp2bLhUb2+P9sj4qVg09BFe+Fe3GND2MJh7Ru4kkw5/CfT0PXdylW3p4txqcc0XLm6UcYBGc9R3QIQId+LjrPIhjC44RmSQwgJZQG1ay8UBmnsZm322ACHsm/gmt3NTwXOoiZnvxl2rjQEh+ZC6nfLVx/aF49SPzG5yYRUtwDExC06Fr/VrQdu3LhE5g3Z8r7U1lW53DATCcBskMayQFx1096EX+bMFo4qOegPKG2FL2toYh4+Xrm2JDjQsHOt5UKqrbu3pczYuwUgTl7PCtkLDO/BpAjTKpf/a6OamGBuVNpqTtdWK5tS7ZvwqZFs4cfB11F+XsOvAwNXorQV7tAworeHK/97Q7Cn4SfXbmrittZ7vXuaC/ZuAYiNq56oeL0ZlrqpfhKpPMLkbBFyMEcZXLXShq4FreQwDd38Wc5cfDL4S6WHyeH4DgxcVR8Pvxf7RNj5buXqkBbDV7nHY9JCqBrFHSAjpkd1C0BsGAV/MnmNiC9yEfJuXOj6cTrB8IZUotq13UL49UcxDX9B/g4MXI69eGY06O5ci+HQVbsYqLFd1UrK30L4siyjugUgKnksOn4yeNST+OVwbaQ3JUDu4+uqXZFPMez9LGebtBBiHg4VuGgr3J+rdrmzSlU92zXsfNx+vHJlMK1qaTTBU8UwKANAdHxXt8R75ScM01Cpnqsepv526/eFLkLei6t2uUl97mxXTG2GrnJpL44Xfhg8ukFVC/NyqMA1aStUoW91f5OzXZM2wz983JYKeN4+mIwf2rtcFyQmblDG+t1VAYDIeF50HN0o+P35r/AkkgRZ5dq23WYYQfBKXdCyQXoh5vOHKMahApejRplWeDgNzcYPhyvXbsd6vsu9X39dvtpz7ZRRtQ++xKguCABEJodR8L0YR8HvZToivhqLkA+yS/BKpQReqmg1CVrw5dCBK8nO0MN6BCq65AKJqwDFUvFyrYPbQSsxfscJF4lWQgCx8r1QN6nYBDs3It6+Zni/IR3KIuTD2A5eLsC44RomyBZTHdm3q0dFC3k5ddg/2Oz2RsNPrvZV46xoeGMrQLbi1f5u5WrqLuSTLOuX6WJ+OgzkbFuN3FQzbh86oZeVayXcoJUQQHxmZ4Ea4k/Uo+D3UrMX7pnnnWauyuVGxJftTNFseErPve1vydaifZzas5bWhuTOhSzjZhJ89ZOc3eR8FvJ06MA1MdY1SUxbcByTM162OiTDlWs9SZI7zc++6EugXDUrM+NFNeZ6TIMwDkIr4fy8Ye8cCqLn7mY3WpeagrkYyRlvF4FP5Vy/LlvePlY+3/aQuZCZx9fAz1JeLtzYT46eTL/Ju61/bdmo2nIBzN7IfU9FW25AiMyNC1dJar8f2G/fimT9Ku3Q+knOfGS/1is/PXsvRbxuGTmi71au/VeVLsA9S+3dlv7Y6IPa+KmtfG0W9mI1rWT9puVClqlYyNpm7yAun1+/R+ssAAA5sxfAjWfuHPzsm/s1e5H6nvveBrK6eRHI0hf/l/m7TsKVO0fndsaOB6elNkordI4Q5XDkwPV45cqq/aQvTS9xqaj07ZPMt5pIvzbWgc/WQzf4YlwzLZNNyvsXYh1+cVhuwXFz/e4NAQAAAOboyIFr2Fmqa/LrkCpXHuzdGtWBC2FiklRNltZMbSTPnqUiW6P9KmLTitUZ+y2pZ4lMS/WaNabhyrT4+L1EbaVRn14sssIIAACAOB05cDlUuULjyuiTcnqdIHVUZmSy7CJTCQEAAODDsYbOMSI+NJOQ1SBsHZ1m2TJhCwAAAL4cK3C5EfGi1dq1gfi4Mf3nu/d7AgAAAHhy7LVKRnVVgJJSlVvn19m3BQAAAL+OHbgmbVhUuVBCKvrt+Y17HQEAAAA8O3bgcqhyoXRU0iSTRQEAAABycKLA5apcrjVLgDKYjH/XBYZkAAAAIC8nClyTv0DfXJ2OJQcCRtgCAABAAU4cuNzEQpWMKhfCRdgCAABAQU4cuCZ/yWQvF1UuBIiwBQAAgALNJXDNqlzLAoSEsAUAAICCGZmj4SdXH6pKW4CiEbYAAAAQgLlUuJ4bG6pcKJzbs0XYAgAAQAjmGria3bsDe7G7JkBBjJjNJNtqE7YAAAAQglMyZ26Ahia/XLc/bAiQI7cT7v2Nux0BAAAAAjHflkKZDtAwmd4QIEcqsnx+4x5hCwAAAEGZe+Bymt37fVdtEMA3Nxwj04Xz6/e6AgAAAATGS+Ca/MX65qr9LhXAF5X+bDhGXwAAAIAAzXUs/E7DzrWWJvqNAHPmKqi0EAIAACB03ipcznRqIQuRMUfbLYSELQAAAJSA1wrXNhYiYx7cyHfJfr7R7G6OBAAAACiBuY+F39VYb0hiHgqj4nEsZuT2u72/fpfBGAAAACiVXCpczrBzpa3T0AUcGlUtAAAAlFlugct5vPK/OkaSDQEO4s5qqd5gAiEAAADKLNfA5Txevto1Rm4KsCvXPpjdSrKtLlUtAAAAlF3ugcv5bvnqN/ZfbgnwEiOmJ1m2ZqtaqQAAAAARyGdoxg5G9SM1DNHAzHSBsQ1a9/oCAAAARKSQCpcz7FxpKJMLq+150OKcFgAAAOJUWOByhp1rLU3Ehi6tC6qDoAUAAICKKDRwOcPO1UUbur4UVMGmyfQWQQsAAABVUXjgcoadK0uamNuCCDF1EAAAANUVROBy2NEVGdoGAQAAgHACl/N45cqqEfOpoJxsyFKjX1HNAgAAAKaCClwOoatknocs6bE/CwAAAHhVcIHLIXSFzIzsJ00/y2zIkqc9KlkAAADA3oIMXA5nukJhRqI6UJUHieiAM1kAAADA4QUbuJzp9EIXutjTlY9ZuBL5VowZJFnWp00QAAAAOL6gA5czXY6sbk9XQzAPqaiMjA1Umerfp8FKRzKtXqUCAAAAYG6CD1yOrXQ1NDEPhdB1MDfEwlWo1AarxIxslSoVF7Jka8R5KwAAACBfpQhcziR0GfOlfYtbgl3ZoLV8fv1eVwAAAAAEoTSBa9vj5atdY+Sm4FW2svX+xr0FAQAAABCMRErm/Ma9joquCV5hjEkFAAAAQFBKF7ic8+v3V01mLsrkbBIAAAAAhKmUgctpdu8OTKYLxkhfAAAAACBApQ1cjhtj3vz83gIthgAAAABCVOrAtW3aYqhNocUQAAAAQECiCFyOq3aZ7M2LqnJLAAAAACAA0QQup9ntjdwUQ3e2S6h2AQAAAChYVIFrm6129d9fv9fkbBcAAACAIkUZuLY9P9ulMhAAAAAAyFnUgctxZ7ve37h30Va7bghthgAAAAByFH3g2marXb3JUA3aDAEAAADkpDKBy5kM1XjRZnhHAAAAAMCjSgWubbM2wyWCFwAAAACfKhm4thG8AAAAAPhU6cC17fXgZUYCAAAAACdE4HrJi+CVMdUQAAAAwIkZwb6GnauLUpObqtKWgBkxveb63RsCAAAAIBhUuA7Q7N7bbH5+b8G1G85GyqcCAAAAAIdAhesYhp0rbTVmyT56H9qfNiQAVLgAAACA8JwSHFmze79vv3PfggxfAAAAAMJA4DqhV8PXtVYm2k5qcjn0M18AAAAA/KOl0JNhZ7EucqaVGbOYJHLBdwCjpRAAAAAIDxUuT5rdTbfLqz/7NuHaDzMxrSQxH6pqw6aklsxJpvp3AQAAABAUKlwFcyHMfhjqWWKDmLhKmAtipiGi9aP8PSZ7drHZ/eNAAAAAAASDwBWoaUviuYatXdkwltjvpSGq9cSY34rRxvM/qGYkWXZrdpYMAAAAAAAAAAAgfv8fPRONIFLoGr8AAAAASUVORK5CYII=\n","altText":"Peach Finance","backgroundColor":"#FFFFFF"}},"options":{"hideReplay":true,"hideDownloadButtons":false,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Java"},{"lang":"Go"}]},"feedback":{"type":"sentiment","settings":{"label":"Was this page helpful?","submitText":"Thanks for your feedback!","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"},"reasons":{"component":"checkbox","dislike":{"label":"What can we improve?","items":["Missing information","Incorrect or outdated content","Hard to understand","Screenshots outdated","Code examples don't work"]}}}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/API Docs/@2025-03-26/api-public.json?download"},{"url":"/_bundle/API Docs/@2025-03-26/api-public.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Peach Finance API","description":"# Introduction\nThis API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\n\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses,\nand uses standard HTTP response codes, authentication, and verbs.\n\nYou can use the API in test mode, which does not affect your live data. The API key you use to authenticate the\nrequest determines whether the request is in live mode or test mode.\n\n# Versioning\n\nThis API is versioned. For more information see [API Versioning Docs](https://docs.peachfinance.com/api-versioning).\nFor a list of available versions—and the breaking changes associated with them—see\n[Breaking Changes](https://docs.peachfinance.com/api-docs/breaking-changes). (Requires Docs Hub login.)\n\n# Pagination\nPeach Finance API utilizes cursor-based pagination via the `startingAfter`\nand `endingBefore` parameters. Both parameters take an existing Object ID\nvalue and return objects in reverse chronological order. The `endingBefore`\nparameter returns objects listed before the named object. The `startingAfter`\nparameter returns objects listed after the named object. If both parameters\nare provided, only `endingBefore` is used.\n\nThe size of the page can be limited using the `limit` parameter.\n`limit` is optional; the default is 25 and can be between 1 and 100.\nSending both `startingBefore` and `endingAfter` is not currently supported.\n\nSome endpoints will allow sending a `sortBy` parameter, enumerating the fields that can be used to\nsort the results returned by that particular endpoint. For example, if the results can be sorted by\n`createdAt` and `updatedAt`, then sending `sortBy=[updatedAt, -createdAt]` will return the results sorted\nby `updatedAt` in ascending order and `createdAt` in descending order lexicographically.\n\n# Metadata\nSome Peach objects have a `metaData` attribute. You can use this attribute to pass\nkey-value data as part of an object.\n\nMetadata can be used when you need to store additional information on an object. Metadata\nis not used by Peach. It is stored as part of an object and returned to you.\n\nDo not store any personal identifiable information (such as SSN) as metadata. Use dedicated\nattributes for PII as these attributes are encrypted.\n\nNote: Metadata attribute can hold up to 50 keys, with key names up to 100 characters long and values\nup to 500 characters long.\n\n# Attributes Formats\nSome Peach attributes use common formats.\n1. **Interest rate, promo rate and APR** - Rates are annual. Format is decimal. For example, 0.005 is 0.5% annual rate, 0.01 is 1% annual rate, 0.2 is 20% annual rate.\n2. **Dates** - Dates are in format `YYYY-MM-DD`. Dates are computed relative to either\n    - the company timezone, which is configured on the company config, or\n    - the product timezone, which is configured on the Loan Type.  Note: it is possible for a company to have multiple products with different timezones.\n3. **Date-times** - Timestamps are in ISO-8601 format expressed either in UTC like `2001-01-01T12:00:00Z` or with UTC offset like\n    `2001-01-01T12:00:00-07:00`. Some date-times will include subsecond precision to an arbitrary number of digits like `2001-01-01T12:00:00.123Z`.\n4. **Amount** - Amounts are in decimal format with 2 places after the decimal point. For example, 32.45 is thirty-two dollars and forty-five cents.\n\n# Identifiers\nPeach objects always have unique identifiers created by Peach. Some objects support external IDs. If external ID is supported, the object will have `externalId` attribute. You can fetch objects using external ID (only objects that support external IDs).\nPeach IDs have the same format XX-YYYY-YYYY.\n\nXX - is a prefix from the list below.\n\nYYYY-YYYY - is a random set of numbers and letters (capital characters A-Z and digits 1-9). The digit zero is not used to avoid confusion with capital letter O.\n\n## External IDs\nExternal IDs allows avoiding the need to map IDs between your system and Peach. You can pass your IDs when creating various objects at Peach and then use the same IDs to fetch\nthe information back.\n\nWhen fetching data with external IDs or when sending a request that requires a reference to an object using its external ID (for example, inside a body of a POST request), there is\na need to add a `ext-` in front of the ID. This will make sure Peach knows these are external IDs being used.\n\nFor example, fetching a borrower using the external ID would look like `GET /api/people/ext-MY_EXTERNAL_BORROWER_ID`.\n\nWhen creating objects with external IDs, the `ext-` prefix is not needed.\nFor example, when creating a new borrower the body would look like:\n```\nPOST /api/people\n{\n  \"externalId\" : \"MY_EXTERNAL_BORROWER_ID\"\n  ...\n}\n```\n\n## List of Prefixes\n\n| Prefix | Object |\n| --- | ----------- |\n| UR | User |\n| BO | Borrower |\n| BN | Person Name |\n| BI | Person Identity |\n| CT | Contact |\n| LT | Loan Type |\n| IR | Investor |\n| LN | Loan |\n| LN | Loan Draw |\n| LA | Installment Advances |\n| CP | Company |\n| TX | Transaction |\n| EV | Event |\n| EM | Event Message |\n| PT | Payment Instrument |\n| PA | Payment ID |\n| DD | Document Descriptor |\n| FT | Fee Type |\n| MS | Person Monitoring Status |\n| CS | Case |\n| CE | Case Type |\n| AP | Autopay |\n| IN | Interaction |\n| DT | Do Not Interact Type |\n| DN | Do Not Interact |\n| NT | Notification Type |\n| NO | Notification |\n| TD | Template Descriptor |\n| TV | Template Version |\n| CO | Code |\n| CR | Compliance Rule |\n| SR | Service |\n| FD | FEMA Disaster Details |\n| NT | Note |\n| CN | Consent |\n| LR | Legal Representative |\n| RL | Role |\n| PM | Permission |\n| WT | Workflow Type |\n| ST | Workflow Step Type |\n| IT | Workflow Item Type |\n| WF | Workflow |\n| WS | Workflow Step |\n| WI | Workflow Workitem |\n| VT | Verification Type |\n| VE | Verification |\n| VA | Verification Attempt |\n| OB | Obligation |\n| RE | Repayment Notification Descriptor  |\n| LP | Loan People |\n| RA | InterestRate |\n| PE | Period (loan)  |\n| IA | Loan Investor Association |\n| SE | Settlement |\n| RF | Loan Refund |\n| SM | Statement |\n| SA | Statement Activity |\n| SD | Statement Draw Info |\n| LF | Loan Fee |\n| AE | Autopay Expected Payment |\n| FE | FEMA Disaster |\n| TY | Loan Tape Type |\n| TA | Loan Tape |\n| MR | Merchant |\n| LS | Loan Reporting Status |\n| CA | Credit Agency |\n| CL | Collection Agency |\n| CI | Card Issuer |\n| WH | Webhook |\n| AF | ACHFile Upload Monitoring |\n| FB | Funding Account Balance |\n| BC | Borrower Campaign |\n| RN | Campaign Run |\n| CX | Contact  Exporter|\n| TC | Transaction Chargeback |\n| PS | Promise to Pay Plan |\n| P2 | Promise to Pay Period |\n| LL | Loan Label |\n| AK | API Key    |\n| AT | AI Call Transcription Result |\n| SU | AI Call Summary Result |\n| RC | Rate Cap |\n\n# Events\nOur system supports pull events via our REST API.\nYou can see more information <a href=\"/api-docs/api-public/events\">here</a>.\n\n# Compliance Guard\nCompliance Guard covers core regulatory obligations related to servicing and\ncollections. It does not cover rules required for debt collection agencies\n(though some of them are applicable to creditors and servicers as a best\npractice.)\n\nCompliance Guard allows you to:\n  - Run real-time regulatory checks before initiating an outbound communication\n  with a borrower. Rules cover laws on the federal level and 50 states + DC. The\n  system runs appropriate rules based on loan type, loan status, location of a borrower,\n  borrower status, and past communications.\n  - Monitor for bankruptcy, deceased, active military, and FEMA (disasters). You can\n  monitor for all four or any combination of the four. On hits, we automatically create \"cases\"\n  with all details, block future outbound communications (if needed), and notify\n  you about the cases.\n\n## Configuring Compliance Guard\n- Peach will configure an appropriate loan type for you. It allows us to select a\npredefined set of regulatory rules\n- Peach will work with you to override regulatory rules based on your risk appetite. You\ncan \"mute\" rules. You can add rules. This is typically done with your legal\nand compliance teams.\n- Peach will work with you to add business rules based on your needs. For example, don't\nallow outbound debt collection calls on Sundays. This is typically done with your\noperations and product teams.\n\n## Implementing Compliance Guard in your system\n- You need to create borrower and loan objects in the Peach system. For more details\nsee <a href=\"/api-docs/api-public/borrowers\">Borrower Management</a> and <a href=\"/api-docs/api-public/loans\">Loans Management</a>.\n- You need to report all communications with a borrower. Not required for monitoring.\nThis way Peach can track all interactions with the borrower. For more details see\n<a href=\"/api-docs/api-public/communicator\">Communicator & Interactions</a>.\n- When sending a communication through Peach it will automatically check Compliance\n  Guard rules to determiend if the communication is compliant. If it is not compliant,\n  the communication will not be rejected. (Some send endpoints do not perform\n  Compliance Guard checks, but they should be clearly marked.)\n- You can also manually check if a communication is compliant by using the\n  <a href=\"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact\">Can interact</a> endpoint.\n\n# Locks\nPeach ensures consistency of the loan's ledger and balances. In order to make sure that\nmultiple operations are not writing to the ledger at the same time, Peach uses locks to protect\nthe consistency of the loan.\n\nIn situations where an API call affects a loan's ledger, the system will lock the\nloan to protect its consistency. Subsequent calls that affect that loan's ledger might\nreturn a `423 Locked` status if the loan is still locked. In these cases, you can make\na call to <a href=\"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status\">Lock Status</a>\nto check if the loan is still locked.\n\nIf you are trying to make a call and get `423 Locked`, consider polling on the <a href=\"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status\">Lock Status</a>\nto check when the lock is released. Most locks are short.\nSome API calls (e.g. retroactive interest adjustment or payment backdate)\ncan trigger a loan replay. Loan replays can last several minutes, during which the loan will\nbe locked.\n\n# Sync calls\nMost of the API endpoints are asynchronous by design. There are situations in which you\nmight want to wait until the API call/operation finishes. Some API endpoints have\na special query parameter called `sync`.\n\nFor example:\n- <a href=\"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create\">Create Payment Instrument</a>\n- <a href=\"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create\">Create Purchase</a>\n\nWhen `sync=true`, the call will be blocked until the async operation has finished.\nIf the operation takes too long, you will get a `408 Request Timeout` response.\nIn that case, you need to poll on that specific operations' result.\nFor example: if you make a call to add a Payment Instrument, and it times out, you can poll\nthe `/payment-instruments` endpoint to see if the new payment instrument has been added.\n\n# Errors\n\n**BETA** - Standardization of error response bodies is in progress.\n\nPeach uses conventional HTTP response codes to indicate the success or failure of an API request.\nIn general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that\nresulted from the provided information (e.g., a required parameter was missing), and codes in the 5xx\nrange indicate an error with the Peach service.\nError response bodies have the following JSON format:\n```json\n{\n    \"statusCode\": 400,\n    \"message\": \"A description of the error.\",\n    \"errorType\": \"TheErrorType\"\n}\n```\nFor a list of error types, see the <a href=\"/api-docs/api-public/errors\">Errors</a> section.\n"}},"baseSlug":"/api-docs/api-public","routesMapping":{}}